Get IM metrics - Zoom API

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.

{ "from": "2019-04-09", "page_count": 1, "page_size": 1, "to": "2019-05-09", "total_records": 1, "users": [ { "calls_receive": 5, "calls_send": 1, "email": "ipsum@ipsumemailksfj.sfhkf", "emoji_receive": 5, "emoji_send": 4, "files_receive": 8, "files_send": 3, "group_receive": 5, "group_send": 5, "images_receive": 2, "images_send": 5, "total_receive": 30, "total_send": 20, "user_id": "sdfjk393lklrf", "user_name": "culpa ipsum", "videos_receive": 2, "videos_send": 1, "voice_receive": 3, "voice_send": 0 } ] }

请求参数

Query 参数

from

string <date>

必需

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.

string <date>

End date.

必需

page_size

integer

可选

The number of records returned within a single API call.

<= 300

默认值:

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.

返回响应

🟢200**HTTP Status Code:** `200`<br> IM details returned.<br> Only available for paid accounts that have enabled the dashboard feature.

application/json

Body

Pagination object.

from

string <date>

可选

Start date for this report.

string <date>

可选

End date for this report.

next_page_token

string

可选

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.

<= 300

默认值:

total_records

integer

可选

The number of all records available across pages.

users

array [object {19}]

可选

calls_receive

integer

可选

Total number of instant meeting calls received by the user.

calls_send

integer

可选

Total number of instant meeting calls made by the user.

string <email>

可选

User email.

emoji_receive

integer

可选

Total number of emojis received by the user.

emoji_send

integer

可选

Total number of emojis sent by the user.

files_receive

integer

可选

Total number of files received by the user.

files_send

integer

可选

Total number of files sent by the user.

group_receive

integer

可选

Total number of messages received by the user in channels.

group_send

integer

可选

Total number of messages sent by the user in channels.

images_receive

integer

可选

Total number of images received by the user.

images_send

integer

可选

Total number of images sent by the user.

total_receive

integer

可选

Total number of messages received by the user.

total_send

integer

可选

Total number of messages sent by the user.

user_id

string

User ID.

可选

user_name

string

可选

User display name.

videos_receive

integer

可选

Total number of video files received by the user.

videos_send

integer

可选

Total number of video files sent by the user.

voice_receive

integer

可选

Total number of voice files received by the user.

voice_send

integer

可选

Total number of voice files sent by the user.