Back to ZoomGet Chat Metrics
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
Input
type: object
properties:
parameters:
type: object
properties:
from:
format: date
type: string
example: '2022-01-01'
description: >-
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:
format: date
type: string
example: '2022-01-28'
description: End date.
page_size:
default: 30
maximum: 300
type: integer
example: 30
description: The number of records returned within a single API call.
next_page_token:
type: string
example: IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB2
description: >-
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.
required:
- from
- to
title: Parameters
Output
type: object
properties:
from:
description: The report's start date.
format: date
type: string
example: '2022-04-06'
next_page_token:
description: >-
The report's [`next_page_token`
value](https://marketplace.zoom.us/docs/api-reference/pagination#next-page-token).
The API returns this value when the set of available results exceeds the
current page size. This token expires after 15 minutes.
type: string
example: LkbB9n92siRxgYkffZ8KhApZCQMZpNrN0d2
page_size:
default: 30
description: The number of records to return within a single API call.
maximum: 300
type: integer
example: 30
to:
description: The report's end date.
format: date
type: string
example: '2022-04-07'
users:
type: array
items:
type: object
properties:
audio_sent:
description: The user's total number of audio files sent.
type: integer
example: 0
code_sippet_sent:
description: The user's total number of code snippets sent.
type: integer
example: 0
email:
description: The user's email address.
format: email
type: string
example:
[email protected]
files_sent:
description: The user's total number of files sent.
type: integer
example: 0
giphys_sent:
description: The user's total number of [GIPHY](https://giphy.com/) images sent.
type: integer
example: 0
group_sent:
description: The user's total number of messages sent in Zoom Chat channels.
type: integer
example: 0
images_sent:
description: The user's total number of images sent.
type: integer
example: 0
p2p_sent:
description: The user's total number of peer-to-peer (P2P) chat messages sent.
type: integer
example: 0
text_sent:
description: The user's total number of text messages sent.
type: integer
example: 0
total_sent:
description: The user's total number of messages sent.
type: integer
example: 0
user_id:
description: The user's ID.
type: string
example: '-0hwjTHMR9uteSRrygQXMA'
user_name:
description: The user's display name.
type: string
example: jchill
video_sent:
description: The user's total number of video files sent.
type: integer
example: 0