查询聊天室统计指标
更新时间: 2024/03/15 14:27:33
网易云信服务端支持按小时/天查询聊天室的主要统计指标,包括聊天室进入人数、活跃人数、消息量的 TopN 数据,助力您更好地进行聊天室运营管理。TopN 值最多可设置为 500,即最多可对 500 个聊天室进行主要统计指标的排名分析。
功能描述
指定时间坐标点查询指定周期内的聊天室主要统计指标(包括聊天室内的活跃数、进入人数和消息数)排名,可指定参与排名的总数。
- 当天的统计指标需要到第二天才能查询。
- 仅支持查询最近 30 天的统计指标。
API 使用限制
单个应用默认最高调用频率:100 次/秒。如超限,将被屏蔽 10 秒。
URL
httpPOST https://api.netease.im/nimserver/stats/chatroom/topn.action HTTP/1.1
Content-Type:application/x-www-form-urlencoded;charset=utf-8
请求参数
-
POST 请求中 Headers 的设置请参考API调用方式。
-
POST 请求中 Body 的设置如下:
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
topn | int | 否 | topn值,可选值 1~500,默认值100 |
timestamp | long | 否 | 需要查询的指标所在的时间坐标点,不提供则默认当前时间,单位秒/毫秒皆可 |
period | String | 否 | 统计周期,可选值包括 hour/day, 默认hour |
orderby | String | 否 | 取排序值,可选值 active/enter/message,分别表示按日活排序,进入人次排序和消息数排序, 默认active |
示例
cURL请求示例
curlcurl -X POST -H "CheckSum: 32dc17d0190f**9367e7" -H "AppKey: fe416640c8e**1847ad2547" -H "Nonce: 1" -H "CurTime: 1451200147" -H "Content-Type: application/x-www-form-urlencoded" -d 'timestamp=1471781873&period=hour&topn=3&orderby=enter' "https://api.netease.im/nimserver/stats/chatroom/topn.action"
请求成功返回示例
json
"Content-Type": "application/json; charset=utf-8"
{
"code": 200,
"data": [
{
"activeNums": 5955, // 该聊天室内的活跃数
"datetime": 1471712400, // 统计时间点,单位秒,按天统计的是当天的0点整点;按小时统计的是指定小时的整点
"enterNums": 18621, // 进入人次数量
"msgs": 2793, // 聊天室内发生的消息数
"period": "HOUR", // 统计周期,HOUR表示按小时统计;DAY表示按天统计
"roomId": 3571337 // 聊天室ID号
},
{
"activeNums": 6047,
"datetime": 1471708800,
"enterNums": 15785,
"msgs": 2706,
"period": "HOUR",
"roomId": 3573737
},
{
"activeNums": 5498,
"datetime": 1471708800,
"enterNums": 14590,
"msgs": 2258,
"period": "HOUR",
"roomId": 3513774
}
]
}
状态码
该 API 在 HTTPS Body 中返回请求的状态码,状态码详情请参见状态码。
此文档是否对你有帮助?