Class ContentSearchResult

An individual search result.

Constructors

constructor

Properties

authorFullName? category? combinedId? description? domain featuredImageUrl? id language? publishedDate? rowId? score subcategory? tableId? tags? title? type url attributeTypeMap discriminator

Methods

getAttributeTypeMap

Constructors

constructor

Properties

OptionalauthorFullName

authorFullName?: string

Name of the author.

Optionalcategory

category?: string

For knowledge articles, the category of the article.

OptionalcombinedId

combinedId?: string

The ID of the document in HubSpot.

Optionaldescription

description?: string

The result's description. The content will be determined by the value of length in the request.

domain

domain: string

The domain the document is hosted on.

OptionalfeaturedImageUrl

featuredImageUrl?: string

URL of the featured image.

id

id: number

The ID of the content.

Optionallanguage

language?: ContentSearchResultLanguageEnum

The document's language.

OptionalpublishedDate

publishedDate?: number

The date the content was published.

OptionalrowId

rowId?: number

If a dynamic page, the row ID in the HubDB table.

score

score: number

The matching score of the document.

Optionalsubcategory

subcategory?: string

For knowledge articles, the subcategory of the article.

OptionaltableId

tableId?: number

If a dynamic page, the ID of the HubDB table.

Optionaltags

tags?: string[]

If a blog post, the tags associated with it.

Optionaltitle

title?: string

The title of the returned document.

type

type: ContentSearchResultTypeEnum

The type of document. Can be SITE_PAGE, LANDING_PAGE, BLOG_POST, LISTING_PAGE, or KNOWLEDGE_ARTICLE.

url

url: string

The url of the document.

Static ReadonlyattributeTypeMap

attributeTypeMap: {
    baseName: string;
    format: string;
    name: string;
    type: string;
}[] = ...

Static Readonlydiscriminator

discriminator: undefined | string = undefined

Methods

StaticgetAttributeTypeMap

  • getAttributeTypeMap(): {
        baseName: string;
        format: string;
        name: string;
        type: string;
    }[]

  • Returns {
        baseName: string;
        format: string;
        name: string;
        type: string;
    }[]

Settings

Member Visibility

On This Page

Constructors
Properties
Methods