Zoom Public API Documentation

Get ZVA Engagements

GET {{baseUrl}}/virtual_agent/report/engagements?from=<date>&to=<date>&timezone=<string>&page_size=10&next_page_token=<string>&include_query_detail=<boolean>

Generate a list of ZVA engagements.

Scopes: zva_report:read

Rate Limit Label: HEAVY

Body PARAM

Key	Datatype	Required	Description
from	string		The start time and date in yyyy-mm-dd or yyyy-MM-dd'T'HH:mm:ss'Z' format. 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 parameters is specified. The end time and date in yyyy-mm-dd or yyyy-MM-dd'T'HH:mm:ss'Z' format, the same format as the from parameter.
timezone	string		The call's [timezone ID](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists/#timezones). The default is UTC.
page_size	number		The number of items returned per page. Constraints: Max: 100 Default: 10
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.
include_query_detail	string		If engagement response includes query details.

HEADERS

Key	Datatype	Required	Description
Accept	string

RESPONSES

status OK

{ "next_page_token": "<string>", "page_size": 10, "total_records": "<integer>", "timezone": "<string>", "engagements": [ { "engagement_id": "<string>", "start_time": "<dateTime>", "duration": "<integer>", "campaign_name": "<string>", "global_variables": [ { "type": "<string>", "value": "<string>", "group_name": "<string>", "group_id": "<string>", "variable_name": "<string>", "variable_id": "<string>", "need_mask": "<boolean>", "need_store": "<boolean>" }, { "type": "<string>", "value": "<string>", "group_name": "<string>", "group_id": "<string>", "variable_name": "<string>", "variable_id": "<string>", "need_mask": "<boolean>", "need_store": "<boolean>" } ], "outcome": "<string>", "launch_url": "<string>", "query_summary": { "query_ids": [ "<string>", "<string>" ], "count": "<integer>" }, "Intent_summary": { "intents_matched": [ { "intent_id": "<string>", "intent_name": "<string>", "intent_type": "default_intent", "accuracy": "<number>", "system_intent": "<boolean>" }, { "intent_id": "<string>", "intent_name": "<string>", "intent_type": "default_intent", "accuracy": "<number>", "system_intent": "<boolean>" } ], "count": "<integer>" }, "language_code": "en-US", "query_details": [ { "query_id": "<string>", "engagement_id": "<string>", "bot_id": "<string>", "bot_session_id": "<string>", "query_time": "<dateTime>", "language_code": "en-US", "query_text": "<string>", "intents": [ { "intent_id": "<string>", "intent_name": "<string>", "intent_type": "default_intent", "accuracy": "<number>", "system_intent": "<boolean>" }, { "intent_id": "<string>", "intent_name": "<string>", "intent_type": "default_intent", "accuracy": "<number>", "system_intent": "<boolean>" } ], "articles": [ { "id": "<string>", "title": "<string>", "answer": "<string>", "url": "<string>", "score": "<number>", "kb_details": [ { "kb_id": "<string>", "kb_name": "<string>", "kb_groups": [ { "id": "<string>", "name": "<string>" }, { "id": "<string>", "name": "<string>" } ] }, { "kb_id": "<string>", "kb_name": "<string>", "kb_groups": [ { "id": "<string>", "name": "<string>" }, { "id": "<string>", "name": "<string>" } ] } ] }, { "id": "<string>", "title": "<string>", "answer": "<string>", "url": "<string>", "score": "<number>", "kb_details": [ { "kb_id": "<string>", "kb_name": "<string>", "kb_groups": [ { "id": "<string>", "name": "<string>" }, { "id": "<string>", "name": "<string>" } ] }, { "kb_id": "<string>", "kb_name": "<string>", "kb_groups": [ { "id": "<string>", "name": "<string>" }, { "id": "<string>", "name": "<string>" } ] } ] } ] }, { "query_id": "<string>", "engagement_id": "<string>", "bot_id": "<string>", "bot_session_id": "<string>", "query_time": "<dateTime>", "language_code": "en-US", "query_text": "<string>", "intents": [ { "intent_id": "<string>", "intent_name": "<string>", "intent_type": "default_intent", "accuracy": "<number>", "system_intent": "<boolean>" }, { "intent_id": "<string>", "intent_name": "<string>", "intent_type": "default_intent", "accuracy": "<number>", "system_intent": "<boolean>" } ], "articles": [ { "id": "<string>", "title": "<string>", "answer": "<string>", "url": "<string>", "score": "<number>", "kb_details": [ { "kb_id": "<string>", "kb_name": "<string>", "kb_groups": [ { "id": "<string>", "name": "<string>" }, { "id": "<string>", "name": "<string>" } ] }, { "kb_id": "<string>", "kb_name": "<string>", "kb_groups": [ { "id": "<string>", "name": "<string>" }, { "id": "<string>", "name": "<string>" } ] } ] }, { "id": "<string>", "title": "<string>", "answer": "<string>", "url": "<string>", "score": "<number>", "kb_details": [ { "kb_id": "<string>", "kb_name": "<string>", "kb_groups": [ { "id": "<string>", "name": "<string>" }, { "id": "<string>", "name": "<string>" } ] }, { "kb_id": "<string>", "kb_name": "<string>", "kb_groups": [ { "id": "<string>", "name": "<string>" }, { "id": "<string>", "name": "<string>" } ] } ] } ] } ], "end_time": "<dateTime>" }, { "engagement_id": "<string>", "start_time": "<dateTime>", "duration": "<integer>", "campaign_name": "<string>", "global_variables": [ { "type": "<string>", "value": "<string>", "group_name": "<string>", "group_id": "<string>", "variable_name": "<string>", "variable_id": "<string>", "need_mask": "<boolean>", "need_store": "<boolean>" }, { "type": "<string>", "value": "<string>", "group_name": "<string>", "group_id": "<string>", "variable_name": "<string>", "variable_id": "<string>", "need_mask": "<boolean>", "need_store": "<boolean>" } ], "outcome": "<string>", "launch_url": "<string>", "query_summary": { "query_ids": [ "<string>", "<string>" ], "count": "<integer>" }, "Intent_summary": { "intents_matched": [ { "intent_id": "<string>", "intent_name": "<string>", "intent_type": "default_intent", "accuracy": "<number>", "system_intent": "<boolean>" }, { "intent_id": "<string>", "intent_name": "<string>", "intent_type": "default_intent", "accuracy": "<number>", "system_intent": "<boolean>" } ], "count": "<integer>" }, "language_code": "en-US", "query_details": [ { "query_id": "<string>", "engagement_id": "<string>", "bot_id": "<string>", "bot_session_id": "<string>", "query_time": "<dateTime>", "language_code": "en-US", "query_text": "<string>", "intents": [ { "intent_id": "<string>", "intent_name": "<string>", "intent_type": "default_intent", "accuracy": "<number>", "system_intent": "<boolean>" }, { "intent_id": "<string>", "intent_name": "<string>", "intent_type": "default_intent", "accuracy": "<number>", "system_intent": "<boolean>" } ], "articles": [ { "id": "<string>", "title": "<string>", "answer": "<string>", "url": "<string>", "score": "<number>", "kb_details": [ { "kb_id": "<string>", "kb_name": "<string>", "kb_groups": [ { "id": "<string>", "name": "<string>" }, { "id": "<string>", "name": "<string>" } ] }, { "kb_id": "<string>", "kb_name": "<string>", "kb_groups": [ { "id": "<string>", "name": "<string>" }, { "id": "<string>", "name": "<string>" } ] } ] }, { "id": "<string>", "title": "<string>", "answer": "<string>", "url": "<string>", "score": "<number>", "kb_details": [ { "kb_id": "<string>", "kb_name": "<string>", "kb_groups": [ { "id": "<string>", "name": "<string>" }, { "id": "<string>", "name": "<string>" } ] }, { "kb_id": "<string>", "kb_name": "<string>", "kb_groups": [ { "id": "<string>", "name": "<string>" }, { "id": "<string>", "name": "<string>" } ] } ] } ] }, { "query_id": "<string>", "engagement_id": "<string>", "bot_id": "<string>", "bot_session_id": "<string>", "query_time": "<dateTime>", "language_code": "en-US", "query_text": "<string>", "intents": [ { "intent_id": "<string>", "intent_name": "<string>", "intent_type": "default_intent", "accuracy": "<number>", "system_intent": "<boolean>" }, { "intent_id": "<string>", "intent_name": "<string>", "intent_type": "default_intent", "accuracy": "<number>", "system_intent": "<boolean>" } ], "articles": [ { "id": "<string>", "title": "<string>", "answer": "<string>", "url": "<string>", "score": "<number>", "kb_details": [ { "kb_id": "<string>", "kb_name": "<string>", "kb_groups": [ { "id": "<string>", "name": "<string>" }, { "id": "<string>", "name": "<string>" } ] }, { "kb_id": "<string>", "kb_name": "<string>", "kb_groups": [ { "id": "<string>", "name": "<string>" }, { "id": "<string>", "name": "<string>" } ] } ] }, { "id": "<string>", "title": "<string>", "answer": "<string>", "url": "<string>", "score": "<number>", "kb_details": [ { "kb_id": "<string>", "kb_name": "<string>", "kb_groups": [ { "id": "<string>", "name": "<string>" }, { "id": "<string>", "name": "<string>" } ] }, { "kb_id": "<string>", "kb_name": "<string>", "kb_groups": [ { "id": "<string>", "name": "<string>" }, { "id": "<string>", "name": "<string>" } ] } ] } ] } ], "end_time": "<dateTime>" } ], "from": "<dateTime>", "to": "<dateTime>" }

Curl

curl -X GET 'https://api.zoom.us/v2/virtual_agent/report/engagements?from=<date>&to=<date>&timezone=<string>&page_size=10&next_page_token=<string>&include_query_detail=<boolean>?from=<date>&to=<date>&timezone=<string>&page_size=10&next_page_token=<string>&include_query_detail=<boolean>' -H 'Accept: application/json'