| Name | Description | Type | Required | Default |
|---|---|---|---|---|
| Accept-Language |
Preferred language code in which data shall be returned. Defaults to English if no translation in the specified language is available. Can be used through the query parameter query or using the header Accept-Language.en - Englishzh - Chineseru - Russianid - Indonesianjp - Japanese
Accepted Values: [
en,zh,ru,id,jp]
|
String | en | |
| Accept |
Response data format. Default is application/json. Can be used through the query parameter format or using the header Accept.
Accepted Values: [
application/json,application/xml]
|
String | json |
| Name | Description | Type | Required | Default |
|---|---|---|---|---|
| lang |
Preferred language code in which data will be returned. Defaults to English if no translation in the language specified is available. Can be used through the query parameter query or using the header Accept-Language.en - Englishzh - Chineseru - Russianid - Indonesianjp - Japanese
Accepted Values: [
en,zh,ru,id,jp]
|
String | en | |
| format |
Response data format. Default is json. Can be used through the query parameter format or using the header Accept.
Accepted Values: [
json,xml]
|
String | json | |
| token | Access API key. | String | ||
| with_model_information |
If set to true returns the model names as part of the response.
|
Boolean | false | |
| group |
Insights group. Default is my.
Accepted Values: [
favorite,my,analytics,shared,all,bin,gallery,wpic_platinum]
|
String | my | |
| limit | Number of records to return | Number | 30 | |
| offset | The offset from which the records will be returned. Used to get the next set of records when the limit is reached. | Number | 0 | |
| keyword |
Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips: Retail Sales - Show series with both keywords while the sequence of keywords is irrelevant. Equivalent to search Sales RetailRetail AND Sales - Show results: series with terms of Retail AND Sales, regardless of the sequence. E. g. Retail Sales, Automobile Sales RetailRetail;Sales - Show series with either keyword and series with both keywords while the sequence of keywords is irrelevant, equivalent to search: Sales;RetailRetail OR Sales - Show results: series with terms of Retail OR Sales, regardless of the sequence. E. g. Retail Sales, Retail Trade, Sales Price, Motor Vehicle SalesRetail NOT Sales - Narrow a search by excluding specific terms while the sequence of keywords is relevant. Show results: series with terms that include Retail, but NOT Sales. E. g. Retail Trade, Retail Price, Retail BankRetail Sales NOT (Hong Kong) - Narrow a search by excluding a set of words in parentheses while the sequence of keywords in parentheses is irrelevant, equivalent to search: Retail Sales NOT (Hong Kong). Show results: series with terms that include Retail Sales, but NOT Hong Kong, such as Retail Sales YoY: China, Retail Sales YoY: United States
|
String | ||
| order |
Sort order
Accepted Values: [
name,edit_date,open_date]
|
Null | edit_date | |
| direction |
Sort order direction
Accepted Values: [
asc,desc]
|
Null | asc | |
| tags | List of insight tags to search by tag | Array | ||
| categories | List of insights categories to search by category | Array |
All API calls have response size limit of 10MB! If you are planning to request a bulky item collection, please consider using the corresponding API request parameters to limit your response.
| Status Code | Description | Type |
|---|---|---|
| 200 | List of insights matching the search criteria | InsightsSearchResult |
| 400 | Incorrect input parameters. | BadRequest |
| 401 | Authorization error. | AuthorizationError |
| 403 | Incorrect user permissions. | PermissionsError |
| 404 | Requested entity not found. | NotFound |
| 415 | Unsupported data format. Only json, xml are supported. | UnsupportedMedia |
| 429 | Too many requests were send or limit exceeded. | TooManyRequests |
| 500 | Internal Server Error. | InternalError |