For a given account and document ID (page ID, blog post ID, HubDB row ID, etc.), return all indexed data for that document. This is useful when debugging why a particular document is not returned from a custom search.
Get indexed properties.
Parameters
contentId: string
ID of the target document when searching for indexed properties.
For a given account and document ID (page ID, blog post ID, HubDB row ID, etc.), return all indexed data for that document. This is useful when debugging why a particular document is not returned from a custom search.
Get indexed properties.
Parameters
contentId: string
ID of the target document when searching for indexed properties.
Returns any website content matching the given search criteria for a given HubSpot account. Searches can be filtered by content type, domain, or URL path.
Search your site.
Parameters
Optionalq: string
The term to search for.
Optionallimit: number
Specifies the number of results to be returned in a single response. Defaults to `10`. Maximum value is `100`.
Optionaloffset: number
Used to page through the results. If there are more results than specified by the `limit` parameter, you will need to use the value of offset returned in the previous request to get the next set of results.
Specifies the language of content to be searched. This value must be a valid ISO 639-1 language code (e.g. `es` for Spanish)
OptionalmatchPrefix: boolean
Inverts the behavior of the pathPrefix filter when set to `false`. Defaults to `true`.
Optionalautocomplete: boolean
Specifies whether or not you are showing autocomplete results. Defaults to false.
OptionalpopularityBoost: number
Specifies how strongly a result is boosted based on its view count. Defaults to 1.0.
OptionalboostLimit: number
Specifies the maximum amount a result will be boosted based on its view count. Defaults to 5.0. Read more about elasticsearch boosting here.
OptionalboostRecent: string
Specifies a relative time window where scores of documents published outside this time window decay. This can only be used for blog posts. For example, boostRecent=10d will boost documents published within the last 10 days. Supported timeunits are ms (milliseconds), s (seconds), m (minutes), h (hours), d (days).
OptionaltableId: number
Specifies a specific HubDB table to search. Only returns results from the specified table. Can be used in tandem with the `hubdbQuery` parameter to further filter results.
OptionalhubdbQuery: string
Specify a HubDB query to further filter the search results.
Optionaldomain: string[]
A domain to match search results for. Multiple domains can be provided with &.
Specifies the type of content to search. Can be one or more of SITE_PAGE, LANDING_PAGE, BLOG_POST, LISTING_PAGE, and KNOWLEDGE_ARTICLE. Defaults to all content types except LANDING_PAGE and KNOWLEDGE_ARTICLE
OptionalpathPrefix: string[]
Specifies a path prefix to filter search results. Will only return results with URL paths that start with the specified parameter. Can be used multiple times.
Optionalproperty: string[]
Specifies which properties to include in the search. Options include `title`, `description`, and `html`. All properties will be searched by default.
Optionallength: "SHORT" | "LONG"
Specifies the length of the search results. Can be set to `LONG` or `SHORT`. `SHORT` will return the first 128 characters of the content's meta description. `LONG` will build a more detailed content snippet based on the html/content of the page.
OptionalgroupId: number[]
Specifies which blog(s) to be searched by blog ID. Can be used multiple times to search more than one blog.
Returns any website content matching the given search criteria for a given HubSpot account. Searches can be filtered by content type, domain, or URL path.
Search your site.
Parameters
Optionalq: string
The term to search for.
Optionallimit: number
Specifies the number of results to be returned in a single response. Defaults to `10`. Maximum value is `100`.
Optionaloffset: number
Used to page through the results. If there are more results than specified by the `limit` parameter, you will need to use the value of offset returned in the previous request to get the next set of results.
Specifies the language of content to be searched. This value must be a valid ISO 639-1 language code (e.g. `es` for Spanish)
OptionalmatchPrefix: boolean
Inverts the behavior of the pathPrefix filter when set to `false`. Defaults to `true`.
Optionalautocomplete: boolean
Specifies whether or not you are showing autocomplete results. Defaults to false.
OptionalpopularityBoost: number
Specifies how strongly a result is boosted based on its view count. Defaults to 1.0.
OptionalboostLimit: number
Specifies the maximum amount a result will be boosted based on its view count. Defaults to 5.0. Read more about elasticsearch boosting here.
OptionalboostRecent: string
Specifies a relative time window where scores of documents published outside this time window decay. This can only be used for blog posts. For example, boostRecent=10d will boost documents published within the last 10 days. Supported timeunits are ms (milliseconds), s (seconds), m (minutes), h (hours), d (days).
OptionaltableId: number
Specifies a specific HubDB table to search. Only returns results from the specified table. Can be used in tandem with the `hubdbQuery` parameter to further filter results.
OptionalhubdbQuery: string
Specify a HubDB query to further filter the search results.
Optionaldomain: string[]
A domain to match search results for. Multiple domains can be provided with &.
Specifies the type of content to search. Can be one or more of SITE_PAGE, LANDING_PAGE, BLOG_POST, LISTING_PAGE, and KNOWLEDGE_ARTICLE. Defaults to all content types except LANDING_PAGE and KNOWLEDGE_ARTICLE
OptionalpathPrefix: string[]
Specifies a path prefix to filter search results. Will only return results with URL paths that start with the specified parameter. Can be used multiple times.
Optionalproperty: string[]
Specifies which properties to include in the search. Options include `title`, `description`, and `html`. All properties will be searched by default.
Optionallength: "SHORT" | "LONG"
Specifies the length of the search results. Can be set to `LONG` or `SHORT`. `SHORT` will return the first 128 characters of the content's meta description. `LONG` will build a more detailed content snippet based on the html/content of the page.
OptionalgroupId: number[]
Specifies which blog(s) to be searched by blog ID. Can be used multiple times to search more than one blog.
For a given account and document ID (page ID, blog post ID, HubDB row ID, etc.), return all indexed data for that document. This is useful when debugging why a particular document is not returned from a custom search. Get indexed properties.