Logo
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
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'

ENDPOINTS