Introduction
Using Zoom APIs
Pagination
Error Definitions
Rate Limits
Testing Zoom APIs with Postman
Account
Audio Library
Auto Receptionists
Blocked List
Call Handling
Call Logs
Call Queues
Carrier Reseller
Common Area Phones
Dashboard
Devices
Directory Backup Routing Rules
Emergency Service Locations
External Contacts
IVR
Monitoring Groups
Phone Numbers
Provider Exchange
Recordings
Reports
Setting Templates
Settings
Shared Access
Shared Line Group
Site
SMS
Users
Voicemails
Zoom Rooms
Cloud Recording
Sessions
Archiving Events
Account Events
App Events
Billing Events
Chat Message Events
Chat Channel Events
Chatbot Events
Meeting Events
Phone Events
Recording Events
TSP Events
User Events
Webinar Events
Video SDK Events
Zoom Room Events
Deprecated API Endpoints
get

/metrics/chat

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.

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
Chat details returned.
Only available for paid accounts that have enabled the dashboard feature.

1 Example
Schema
object
from
string

The report’s start date.

1 validation
to
string

The report’s end date.

1 validation
page_size
integer

The number of records to return within a single API call.

2 validations
next_page_token
string

The report’s next_page_token value. The API returns this value when the set of available results exceeds the current page size. This token expires after 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