Unified Search
GET {{baseUrl}}/api/v2/guide/search?query=<string>&filter[locales]=<string>&filter[category_ids]=<string>&filter[section_ids]=<string>&filter[topic_ids]=<string>&filter[external_source_ids]=<string>&filter[brand_ids]=<string>&filter[content_types]=<string>&page[after]=<string>&page[size]=<integer>
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
query | string | The search text to be matched or a search string | |
filter[locales] | string | (Required) Limit the search to these locales. See Filtering by Locale | |
filter[category_ids] | string | Limit the search to articles in these categories. See Filtering by Category | |
filter[section_ids] | string | Limit the search to articles in these sections. See Filtering by Section | |
filter[topic_ids] | string | Limit the search to posts in these topics. See Filtering by Topic | |
filter[external_source_ids] | string | Use this parameter to scope the result of your search to a specific external source or external sources. | |
| If no external source is given, results are returned across all sources | |||
filter[brand_ids] | string | Limit the search to articles or posts within these brands. If no brand is specified, results are returned across all brands. | |
| If you want to scope the result of your search with multiple brands, separate each value with a comma | |||
filter[content_types] | string | Limit the search to one of these content types: ARTICLE, POST. | |
At present, it is not possible to specify EXTERNAL_RECORD. | |||
Instead, use the filter[external_source_id] parameter above | |||
page[after] | string | A string representing the cursor to the next page. | |
page[size] | string | A numeric value that indicates the maximum number of items that can | |
| be included in a response. The value of this parameter has an upper | |||
| limit of 50. The default value is 10. | |||
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"meta":{"after_cursor":"\u003cstring\u003e","before_cursor":"\u003cstring\u003e","has_more":"\u003cboolean\u003e"},"results":[{"title":"\u003cstring\u003e","type":"EXTERNAL_RECORD","updated_at":"\u003cdateTime\u003e","url":"\u003cstring\u003e"},{"title":"\u003cstring\u003e","type":"EXTERNAL_RECORD","updated_at":"\u003cdateTime\u003e","url":"\u003cstring\u003e"}]}