Zoom Public API Documentation
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: Rate Limit Label: account:read:admin,iq_account:read:adminMedium
Body
PARAM
| 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": "<string>",
"page_size": 30,
"indicators": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"category_id": "<string>",
"category_name": "<string>",
"type": "advanced",
"mentioned_by": "prospects",
"enabled": "<boolean>",
"created_time": "<dateTime>",
"last_modified_time": "<dateTime>",
"last_modified_user_name": "<string>"
},
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"category_id": "<string>",
"category_name": "<string>",
"type": "advanced",
"mentioned_by": "prospects",
"enabled": "<boolean>",
"created_time": "<dateTime>",
"last_modified_time": "<dateTime>",
"last_modified_user_name": "<string>"
}
]
} |
Curl
curl -X GET 'https://api.zoom.us/v2/iq/settings/indicators?category_id=<string>&type=guiding_sentences&page_size=30&next_page_token=<string>?category_id=<string>&type=guiding_sentences&page_size=30&next_page_token=<string>' -H 'Accept: application/json'
ENDPOINTS