GET /metrics/im
Get metrics on how users are utilizing the Zoom Chat Client.
You can specify a monthly date range for the dashboard data using the from and to query parameters. The month should fall within the last six months.
Scope: dashboard_im:read:admin
Rate Limit Label: Resource-intensive
Prerequisites:
- Business or a higher plan.
Servers
- https://api.zoom.us/v2
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
to |
String | Yes |
End date. |
page_size |
Integer | No |
The number of records returned within a single API call. Default value: 30 |
next_page_token |
String | No |
The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes. |
from |
String | Yes |
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. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.