获取聊天指标

获取 [指标](https://support.zoom.us/hc/en-us/articles/204654719-仪表板 # h_cc7e9749-1c70-4afb-a9a2-9680654821e4)，了解用户如何利用缩放聊天发送消息。

使用 “从” 和 “到” 查询参数指定仪表板数据的每月日期范围。每月日期范围必须在最近六个月内。

** 注意: ** 要查询2021年7月1日及以后的聊天指标，使用此端点而不是 [** 获取IM指标 **](/docs/api-reference/zoom-api/methods # operation/dashboardIM) api。

** 先决条件: **

业务或更高的计划

** 范围: ** 'dashboard_im:master'

** [速率限制标签](https://marketplace.zoom.us/docs/api-reference/Rate-limits # 速率限制):** '资源密集型'

请求参数

Path 参数

accountId

string

帐户的唯一标识符。

必需

Query 参数

from

string

必需

以 'yyyy-mm-d' 格式的开始日期。“从” 和 “到” 参数定义的日期范围应该只有一个月，因为报告一次只包括一个月的数据。

string

结束日期。

必需

page_size

integer

可选

单个API调用中返回的记录数。

next_page_token

string

可选

使用next page标记对大型结果集进行分页。只要可用结果集超过当前页面大小时，就会返回下一页令牌。此令牌的有效期为15分钟。

返回响应

🟢200** HTTP状态代码: ** '200' 已返回聊天详细信息。仅适用于已启用仪表板功能的付费帐户。

application/json

Body

next_page_token

string

可选

报告的 ['next_page_token' 值](https://marketplace.zoom.us/docs/api-reference/分页 # next-page-token)。当可用结果集超过当前页面大小时，API将返回此值。此令牌在15分钟后过期。

示例值:

LkbB9n92siRxgYkffZ8KhApZCQMZpNrN0d2

from

string <date>

报告的开始日期。

可选

示例值:

2022-04-06

string <date>

报告的结束日期。

可选

示例值:

2022-04-07

users

array [object {13}]

可选

images_sent

integer

可选

用户发送的图像总数。

示例值:

p2p_sent

integer

可选

用户发送的对等 (P2P) 聊天消息的总数。

示例值:

user_name

string

用户的显示名称。

可选

示例值:

jchill

total_sent

integer

可选

用户发送的消息总数。

示例值:

group_sent

integer

可选

用户在Zoom聊天频道中发送的消息总数。

示例值:

text_sent

integer

可选

用户发送的文本消息总数。

示例值:

video_sent

integer

可选

用户发送的视频文件总数。

示例值:

giphys_sent

integer

可选

用户发送的 GIPHY 图像总数。

示例值:

code_sippet_sent

integer

可选

用户发送的代码段总数。

示例值:

user_id

string

用户的ID。

可选

示例值:

-0hwjTHMR9uteSRrygQXMA

files_sent

integer

可选

用户发送的文件总数。

示例值:

audio_sent

integer

可选

用户发送的音频文件总数。

示例值:

string <email>

可选

用户的电子邮件地址。

示例值:

user@example.com

page_size

integer

可选

在单个API调用中返回的记录数。

<= 300

默认值:

示例值:

示例

{
    "next_page_token": "LkbB9n92siRxgYkffZ8KhApZCQMZpNrN0d2",
    "from": "2022-04-06",
    "to": "2022-04-07",
    "users": [
        {
            "images_sent": 0,
            "p2p_sent": 0,
            "user_name": "jchill",
            "total_sent": 0,
            "group_sent": 0,
            "text_sent": 0,
            "video_sent": 0,
            "giphys_sent": 0,
            "code_sippet_sent": 0,
            "user_id": "-0hwjTHMR9uteSRrygQXMA",
            "files_sent": 0,
            "audio_sent": 0,
            "email": "user@example.com"
        }
    ],
    "page_size": 30
}

请求参数

示例代码

返回响应