Zoom Public API Documentation
List variable logs
GET {{baseUrl}}/contact_center/variable_logs?next_page_token=<string>&page_size=30&from=<date>&to=<date>&group_type=system&data_type=boolean&engagement_id=<string>&flow_id=<string>&widget_name=<string>&variable_name=<string>&variable_value=<string>
Return a list of variable logs. Scopes: Rate Limit Label: contact_center_variable_log:read:adminHeavy
Body
PARAM
| Key | Datatype | Required | Description |
next_page_token
|
string | Use the next page token to paginate through large result sets. A next page token returns whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes. | |
page_size
|
number | The number of items returned per page. | |
from
|
string | The start time and date in yyyy-mm-dd or ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss'Z' or yyyy-MM-dd'T'HH:mm:ss’TZD’). The defined date range should be a month, as the response only includes one month's worth of data. If no start date is specified, return data from the past 24 hours. | |
to
|
string | **Required** only when the `from` parameter is specified. The end time and date in yyyy-mm-dd or ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss'Z' or yyyy-MM-dd'T'HH:mm:ss’TZD’). | |
group_type
|
string | The variable group's type. | |
data_type
|
string | The variable data's type. | |
engagement_id
|
string | The engagement's ID. | |
flow_id
|
string | The flow's ID. | |
widget_name
|
string | The widget's name. | |
variable_name
|
string | The variable's name. | |
variable_value
|
string | The variable's value. |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"next_page_token": "<string>",
"page_size": 10,
"total_records": "<integer>",
"from": "<dateTime>",
"to": "<dateTime>",
"variable_logs": [
{
"variable_log_id": "<string>",
"engagement_id": "<string>",
"flow_id": "<string>",
"flow_name": "<string>",
"widget_name": "<string>",
"variable_name": "<string>",
"variable_value": "<string>",
"group_type": "system",
"data_type": "currency",
"created_at": "<dateTime>"
},
{
"variable_log_id": "<string>",
"engagement_id": "<string>",
"flow_id": "<string>",
"flow_name": "<string>",
"widget_name": "<string>",
"variable_name": "<string>",
"variable_value": "<string>",
"group_type": "custom",
"data_type": "percent",
"created_at": "<dateTime>"
}
]
} |
Curl
curl -X GET 'https://api.zoom.us/v2/contact_center/variable_logs?next_page_token=<string>&page_size=30&from=<date>&to=<date>&group_type=system&data_type=boolean&engagement_id=<string>&flow_id=<string>&widget_name=<string>&variable_name=<string>&variable_value=<string>?next_page_token=<string>&page_size=30&from=<date>&to=<date>&group_type=system&data_type=boolean&engagement_id=<string>&flow_id=<string>&widget_name=<string>&variable_name=<string>&variable_value=<string>' -H 'Accept: application/json'
ENDPOINTS