Zoom Public API Documentation
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 > Note: To query chat metrics from July 1, 2021 and later, use this endpoint instead of the Get IM metrics API. Prerequisites: Scopes: Rate Limit Label: 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.
dashboard_im:read:admin,dashboard:read:adminResource-intensive
Body
PARAM
| 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": "<date>",
"next_page_token": "<string>",
"page_size": 30,
"to": "<date>",
"users": [
{
"audio_sent": "<integer>",
"code_sippet_sent": "<integer>",
"email": "<email>",
"files_sent": "<integer>",
"giphys_sent": "<integer>",
"group_sent": "<integer>",
"images_sent": "<integer>",
"p2p_sent": "<integer>",
"text_sent": "<integer>",
"total_sent": "<integer>",
"user_id": "<string>",
"user_name": "<string>",
"video_sent": "<integer>"
},
{
"audio_sent": "<integer>",
"code_sippet_sent": "<integer>",
"email": "<email>",
"files_sent": "<integer>",
"giphys_sent": "<integer>",
"group_sent": "<integer>",
"images_sent": "<integer>",
"p2p_sent": "<integer>",
"text_sent": "<integer>",
"total_sent": "<integer>",
"user_id": "<string>",
"user_name": "<string>",
"video_sent": "<integer>"
}
]
} |
Curl
curl -X GET 'https://api.zoom.us/v2/metrics/chat?from=<date>&to=<date>&page_size=30&next_page_token=<string>?from=<date>&to=<date>&page_size=30&next_page_token=<string>' -H 'Accept: application/json'
ENDPOINTS