Zoom Public API Documentation

Get ZVA Query Details

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

Returns a list of ZVA engagement query details.

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, it returns data from the past 24 hours.
to	string		The field is required only when the from parameter is specified. The end time and date is in the yyyy-mm-dd or yyyy-MM-dd'T'HH:mm:ss'Z' format, which is 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		The next page token paginates through a large set of results. A next page token returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.
engagement_ids	string		The engagement IDs string separated by ",".

HEADERS

Key	Datatype	Required	Description
Accept	string

RESPONSES

status OK

{ "from": "<dateTime>", "to": "<dateTime>", "next_page_token": "<string>", "page_size": 10, "total_records": "<integer>", "timezone": "<string>", "engagement_query_details": [ { "engagement_id": "<string>", "query_details": [ { "query_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": true }, { "intent_id": "<string>", "intent_name": "<string>", "intent_type": "default_intent", "accuracy": "<number>", "system_intent": true } ], "articles": [ { "article_id": "<string>", "article_title": "<string>", "article_answer": "<string>", "article_url": "<string>", "article_score": "<number>", "kb_details": [ { "kb_id": "<string>", "kb_name": "<string>", "kb_groups": [ { "group_id": "<string>", "group_name": "<string>" }, { "group_id": "<string>", "group_name": "<string>" } ] }, { "kb_id": "<string>", "kb_name": "<string>", "kb_groups": [ { "group_id": "<string>", "group_name": "<string>" }, { "group_id": "<string>", "group_name": "<string>" } ] } ] }, { "article_id": "<string>", "article_title": "<string>", "article_answer": "<string>", "article_url": "<string>", "article_score": "<number>", "kb_details": [ { "kb_id": "<string>", "kb_name": "<string>", "kb_groups": [ { "group_id": "<string>", "group_name": "<string>" }, { "group_id": "<string>", "group_name": "<string>" } ] }, { "kb_id": "<string>", "kb_name": "<string>", "kb_groups": [ { "group_id": "<string>", "group_name": "<string>" }, { "group_id": "<string>", "group_name": "<string>" } ] } ] } ] }, { "query_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": true }, { "intent_id": "<string>", "intent_name": "<string>", "intent_type": "default_intent", "accuracy": "<number>", "system_intent": true } ], "articles": [ { "article_id": "<string>", "article_title": "<string>", "article_answer": "<string>", "article_url": "<string>", "article_score": "<number>", "kb_details": [ { "kb_id": "<string>", "kb_name": "<string>", "kb_groups": [ { "group_id": "<string>", "group_name": "<string>" }, { "group_id": "<string>", "group_name": "<string>" } ] }, { "kb_id": "<string>", "kb_name": "<string>", "kb_groups": [ { "group_id": "<string>", "group_name": "<string>" }, { "group_id": "<string>", "group_name": "<string>" } ] } ] }, { "article_id": "<string>", "article_title": "<string>", "article_answer": "<string>", "article_url": "<string>", "article_score": "<number>", "kb_details": [ { "kb_id": "<string>", "kb_name": "<string>", "kb_groups": [ { "group_id": "<string>", "group_name": "<string>" }, { "group_id": "<string>", "group_name": "<string>" } ] }, { "kb_id": "<string>", "kb_name": "<string>", "kb_groups": [ { "group_id": "<string>", "group_name": "<string>" }, { "group_id": "<string>", "group_name": "<string>" } ] } ] } ] } ] }, { "engagement_id": "<string>", "query_details": [ { "query_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": true }, { "intent_id": "<string>", "intent_name": "<string>", "intent_type": "default_intent", "accuracy": "<number>", "system_intent": true } ], "articles": [ { "article_id": "<string>", "article_title": "<string>", "article_answer": "<string>", "article_url": "<string>", "article_score": "<number>", "kb_details": [ { "kb_id": "<string>", "kb_name": "<string>", "kb_groups": [ { "group_id": "<string>", "group_name": "<string>" }, { "group_id": "<string>", "group_name": "<string>" } ] }, { "kb_id": "<string>", "kb_name": "<string>", "kb_groups": [ { "group_id": "<string>", "group_name": "<string>" }, { "group_id": "<string>", "group_name": "<string>" } ] } ] }, { "article_id": "<string>", "article_title": "<string>", "article_answer": "<string>", "article_url": "<string>", "article_score": "<number>", "kb_details": [ { "kb_id": "<string>", "kb_name": "<string>", "kb_groups": [ { "group_id": "<string>", "group_name": "<string>" }, { "group_id": "<string>", "group_name": "<string>" } ] }, { "kb_id": "<string>", "kb_name": "<string>", "kb_groups": [ { "group_id": "<string>", "group_name": "<string>" }, { "group_id": "<string>", "group_name": "<string>" } ] } ] } ] }, { "query_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": true }, { "intent_id": "<string>", "intent_name": "<string>", "intent_type": "default_intent", "accuracy": "<number>", "system_intent": true } ], "articles": [ { "article_id": "<string>", "article_title": "<string>", "article_answer": "<string>", "article_url": "<string>", "article_score": "<number>", "kb_details": [ { "kb_id": "<string>", "kb_name": "<string>", "kb_groups": [ { "group_id": "<string>", "group_name": "<string>" }, { "group_id": "<string>", "group_name": "<string>" } ] }, { "kb_id": "<string>", "kb_name": "<string>", "kb_groups": [ { "group_id": "<string>", "group_name": "<string>" }, { "group_id": "<string>", "group_name": "<string>" } ] } ] }, { "article_id": "<string>", "article_title": "<string>", "article_answer": "<string>", "article_url": "<string>", "article_score": "<number>", "kb_details": [ { "kb_id": "<string>", "kb_name": "<string>", "kb_groups": [ { "group_id": "<string>", "group_name": "<string>" }, { "group_id": "<string>", "group_name": "<string>" } ] }, { "kb_id": "<string>", "kb_name": "<string>", "kb_groups": [ { "group_id": "<string>", "group_name": "<string>" }, { "group_id": "<string>", "group_name": "<string>" } ] } ] } ] } ] } ] }

Curl

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