Get indicators settings
GET {{baseUrl}}/iq/settings/indicators?category_id=<string>&type=guiding_sentences&page_size=30&next_page_token=<string>
Get the account's indicators settings.
Prerequisites:
- The account must be a paid account.
Scopes:
account:read:admin
,
iq_account:read:admin
Rate Limit Label
:
Medium
Request Params
| Key | Datatype | Required | Description |
| category_id
| string | | The category id of indicators: |
| type
| string | | The type of indicators:
basic
— Identify basic keyword phrases.advanced
— Identify advanced keyword phrases.guiding_sentences
— Identify guiding sentences. | |page_size
| number | | The number of records returned within a single API call. | |next_page_token
| string | | The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes. |
HEADERS
| Key | Datatype | Required | Description |
| Accept
| string | | |
RESPONSES
status: OK
{"next_page_token":"\u003cstring\u003e","page_size":30,"indicators":[{"id":"\u003cstring\u003e","name":"\u003cstring\u003e","description":"\u003cstring\u003e","category_id":"\u003cstring\u003e","category_name":"\u003cstring\u003e","type":"advanced","mentioned_by":"prospects","enabled":"\u003cboolean\u003e","created_time":"\u003cdateTime\u003e","last_modified_time":"\u003cdateTime\u003e","last_modified_user_name":"\u003cstring\u003e"},{"id":"\u003cstring\u003e","name":"\u003cstring\u003e","description":"\u003cstring\u003e","category_id":"\u003cstring\u003e","category_name":"\u003cstring\u003e","type":"advanced","mentioned_by":"prospects","enabled":"\u003cboolean\u003e","created_time":"\u003cdateTime\u003e","last_modified_time":"\u003cdateTime\u003e","last_modified_user_name":"\u003cstring\u003e"}]}