All URIs are relative to https://api.hubapi.com
| Method | HTTP request | Description |
|---|---|---|
| GetCmsV3SiteSearchIndexedDataContentIdGetById | GET /cms/v3/site-search/indexed-data/{contentId} | Get indexed properties. |
| GetCmsV3SiteSearchSearchSearch | GET /cms/v3/site-search/search | Search your site. |
IndexedData GetCmsV3SiteSearchIndexedDataContentIdGetById (string contentId, string type = null)
Get 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.
using System.Collections.Generic;
using System.Diagnostics;
using HubSpot.NET.Api;
using HubSpot.NET.Client;
using HubSpot.NET.Model;
namespace Example
{
public class GetCmsV3SiteSearchIndexedDataContentIdGetByIdExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://api.hubapi.com";
var apiInstance = new PublicApi(config);
var contentId = "contentId_example"; // string | ID of the target document when searching for indexed properties.
var type = "LANDING_PAGE"; // string | The type of document. Can be one of `SITE_PAGE`, `BLOG_POST`, or `KNOWLEDGE_ARTICLE`. (optional)
try
{
// Get indexed properties.
IndexedData result = apiInstance.GetCmsV3SiteSearchIndexedDataContentIdGetById(contentId, type);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling PublicApi.GetCmsV3SiteSearchIndexedDataContentIdGetById: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| contentId | string | ID of the target document when searching for indexed properties. | |
| type | string | The type of document. Can be one of `SITE_PAGE`, `BLOG_POST`, or `KNOWLEDGE_ARTICLE`. | [optional] |
No authorization required
- Content-Type: Not defined
- Accept: application/json, /
| Status code | Description | Response headers |
|---|---|---|
| 200 | successful operation | - |
| 0 | An error occurred. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PublicSearchResults GetCmsV3SiteSearchSearchSearch (string q = null, int? limit = null, int? offset = null, string language = null, bool? matchPrefix = null, bool? autocomplete = null, decimal? popularityBoost = null, decimal? boostLimit = null, decimal? minScore = null, string boostRecent = null, long? tableId = null, string hubdbQuery = null, List domain = null, List type = null, List pathPrefix = null, List property = null, string length = null, List groupId = null)
Search your site.
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.
using System.Collections.Generic;
using System.Diagnostics;
using HubSpot.NET.Api;
using HubSpot.NET.Client;
using HubSpot.NET.Model;
namespace Example
{
public class GetCmsV3SiteSearchSearchSearchExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://api.hubapi.com";
var apiInstance = new PublicApi(config);
var q = "q_example"; // string | The term to search for. (optional)
var limit = 56; // int? | Specifies the number of results to be returned in a single response. Defaults to `10`. Maximum value is `100`. (optional)
var offset = 56; // int? | 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. (optional)
var language = "af"; // string | Specifies the language of content to be searched. This value must be a valid [ISO 639-1 language code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) (e.g. `es` for Spanish) (optional)
var matchPrefix = true; // bool? | Inverts the behavior of the pathPrefix filter when set to `false`. Defaults to `true`. (optional)
var autocomplete = true; // bool? | Specifies whether or not you are showing autocomplete results. Defaults to false. (optional)
var popularityBoost = 8.14D; // decimal? | Specifies how strongly a result is boosted based on its view count. Defaults to 1.0. (optional)
var boostLimit = 8.14D; // decimal? | Specifies the maximum amount a result will be boosted based on its view count. Defaults to 5.0. Read more about elasticsearch boosting [here](https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-boost.html). (optional)
var minScore = 8.14D; // decimal? | Specifies the minimum search score threshold for returned results. This value is intentionally set low by default in order to return many results. Increase this for higher precision, but less recall. (optional)
var boostRecent = "boostRecent_example"; // 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). (optional)
var tableId = 789L; // long? | 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. (optional)
var hubdbQuery = "hubdbQuery_example"; // string | Specify a HubDB query to further filter the search results. (optional)
var domain = new List<string>(); // List<string> | A domain to match search results for. Multiple domains can be provided with &. (optional)
var type = new List<string>(); // List<string> | 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 (optional)
var pathPrefix = new List<string>(); // List<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. (optional)
var property = new List<string>(); // List<string> | Specifies which properties to include in the search. Options include `title`, `description`, and `html`. All properties will be searched by default. (optional)
var length = "SHORT"; // string | 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. (optional)
var groupId = new List<long>(); // List<long> | Specifies which blog(s) to be searched by blog ID. Can be used multiple times to search more than one blog. (optional)
try
{
// Search your site.
PublicSearchResults result = apiInstance.GetCmsV3SiteSearchSearchSearch(q, limit, offset, language, matchPrefix, autocomplete, popularityBoost, boostLimit, minScore, boostRecent, tableId, hubdbQuery, domain, type, pathPrefix, property, length, groupId);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling PublicApi.GetCmsV3SiteSearchSearchSearch: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| q | string | The term to search for. | [optional] |
| limit | int? | Specifies the number of results to be returned in a single response. Defaults to `10`. Maximum value is `100`. | [optional] |
| offset | int? | 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. | [optional] |
| language | string | Specifies the language of content to be searched. This value must be a valid ISO 639-1 language code (e.g. `es` for Spanish) | [optional] |
| matchPrefix | bool? | Inverts the behavior of the pathPrefix filter when set to `false`. Defaults to `true`. | [optional] |
| autocomplete | bool? | Specifies whether or not you are showing autocomplete results. Defaults to false. | [optional] |
| popularityBoost | decimal? | Specifies how strongly a result is boosted based on its view count. Defaults to 1.0. | [optional] |
| boostLimit | decimal? | Specifies the maximum amount a result will be boosted based on its view count. Defaults to 5.0. Read more about elasticsearch boosting here. | [optional] |
| minScore | decimal? | Specifies the minimum search score threshold for returned results. This value is intentionally set low by default in order to return many results. Increase this for higher precision, but less recall. | [optional] |
| boostRecent | 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). | [optional] |
| tableId | long? | 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. | [optional] |
| hubdbQuery | string | Specify a HubDB query to further filter the search results. | [optional] |
| domain | List<string> | A domain to match search results for. Multiple domains can be provided with &. | [optional] |
| type | List<string> | 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 | [optional] |
| pathPrefix | List<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. | [optional] |
| property | List<string> | Specifies which properties to include in the search. Options include `title`, `description`, and `html`. All properties will be searched by default. | [optional] |
| length | string | 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. | [optional] |
| groupId | List<long> | Specifies which blog(s) to be searched by blog ID. Can be used multiple times to search more than one blog. | [optional] |
No authorization required
- Content-Type: Not defined
- Accept: application/json, /
| Status code | Description | Response headers |
|---|---|---|
| 200 | successful operation | - |
| 0 | An error occurred. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]