Introduction
Using Zoom APIs
Pagination
Error Definitions
Rate Limits
Testing Zoom APIs
Account Events
App Events
Chat Message Events
Chat Channel Events
Chatbot Events
Meeting Events
Phone Events
Recording Events
TSP Events
User Events
Webinar Events
Zoom Room Events
Data Compliance
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.

Authorization

oauth2 - authorizationCode

Request Parameters

4 Query Parameters

Responses

HTTP Status Code: 200
IM details returned.
Only available for paid accounts that have enabled the dashboard feature.

1 Example
Schema
object

Pagination object.

from
string

Start date for this report.

1 validation
to
string

End date for this report.

1 validation
page_count
integer

The number of pages returned for the request made.

page_size
integer

The number of records returned within a single API call.

2 validations
total_records
integer

The number of all records available across pages.

next_page_token
string

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.

users
array[object]

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
$$.env
1 variable not set
oauth_access_token