Get chat metrics
GET {{baseUrl}}/metrics/chat?from=<date>&to=<date>&page_size=30&next_page_token=<string>
Get metrics for how users are utilizing Zoom Chat to send messages.
Use the
from
and
to
query parameters to specify a monthly date range for the dashboard data. The monthly date range must be within the last six months.
> Note: To query chat metrics from July 1, 2021 and later, use this endpoint instead of the Get IM metrics API.
Prerequisites:
- Business or a higher plan
Scopes:
dashboard_im:read:admin
,
dashboard:read:admin
Rate Limit Label
:
Resource-intensive
Request Params
| Key | Datatype | Required | Description |
| from | string | | (Required) Start date in 'yyyy-mm-dd' format. The date range defined by the "from" and "to" parameters should only be one month as the report includes only one month worth of data at once. |
| to | string | | (Required) End date. |
| page_size | number | | The number of records returned within a single API call. |
| next_page_token | string | | Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes. |
HEADERS
| Key | Datatype | Required | Description |
| Accept | string | | |
RESPONSES
status: OK
{"from":"\u003cdate\u003e","next_page_token":"\u003cstring\u003e","page_size":30,"to":"\u003cdate\u003e","users":[{"audio_sent":"\u003cinteger\u003e","code_sippet_sent":"\u003cinteger\u003e","email":"\u003cemail\u003e","files_sent":"\u003cinteger\u003e","giphys_sent":"\u003cinteger\u003e","group_sent":"\u003cinteger\u003e","images_sent":"\u003cinteger\u003e","p2p_sent":"\u003cinteger\u003e","text_sent":"\u003cinteger\u003e","total_sent":"\u003cinteger\u003e","user_id":"\u003cstring\u003e","user_name":"\u003cstring\u003e","video_sent":"\u003cinteger\u003e"},{"audio_sent":"\u003cinteger\u003e","code_sippet_sent":"\u003cinteger\u003e","email":"\u003cemail\u003e","files_sent":"\u003cinteger\u003e","giphys_sent":"\u003cinteger\u003e","group_sent":"\u003cinteger\u003e","images_sent":"\u003cinteger\u003e","p2p_sent":"\u003cinteger\u003e","text_sent":"\u003cinteger\u003e","total_sent":"\u003cinteger\u003e","user_id":"\u003cstring\u003e","user_name":"\u003cstring\u003e","video_sent":"\u003cinteger\u003e"}]}