查询房间统计信息

更新时间: 2023/09/12 12:25:18

接口描述:该接口可以查询房间用量,按天计算,主要的数据项包括房间数量(只统计当天已经结束的房间),房间总时长(只统计当天已经结束的房间),房间成员总数(),房间成员最大并发数量。

使用场景:主要用于查看相关的统计信息

接口请求地址

  • 请求方法:GET
  • URL:https://roomkit.netease.im/scene/apps/{appId}/v1/statistics/room-trend

URL 中参数说明

请求 Header 的设置请参见 请求结构

参数名称 类型 是否必选 示例 描述
startTime Long 查询开始时间戳,为一天的开始时间戳 如:2023/2/10 00:00:00
endTime Long 查询结束时间戳,为一天的结束时间戳 如 2023/2/10 23.59.59
pageNum Integer 页码
pageSize Integer 每页数量

返回参数

参数名称 类型 示例 描述
code int 0 状态码,0 表示成功,具体请参见错误码
msg String Success 业务结果描述,Success表示成功
ts Long 1648021056815 NERoom 服务器处理该请求的完成时间。该时间为 Unix 时间戳,即从 1970 年 1 月 1 日 0 点 0 分 0 秒开始到现在的秒数
requestId String 7c4b6ty6e9d42*****cc6e3a4d995 请求的唯一标识
cost String 48ms 处理该请求所消耗的时间
data Object - 统计信息
data.endRoomCount String 4***251 已经结束的房间数量
data.endRoomTimeCount String NE***10 结束房间总时长,以毫秒计
data.roomMemberCount Integer 40 在统计日期内进入过房间成员数量,以用户ID去重计算
data.roomMemberConcurrence String Name*** 房间成员并发数
data.statisticDate Integer 1 统计日期

示例

请求示例

javahttps://roomkit.netease.im/scene/apps/1234389479831249/v1/statistics/room-trend

返回示例

java{
{
    "code":0,
    "msg":"Operation succeeded.",
    "ts":1676269048300,
    "cost":"17ms",
    "requestId":"test_425d361698f945db8990be15a3541a29",
    "data":{
        "pageNum":1,
        "pageSize":10,
        "total":31,
        "list":[
            {
                "endRoomCount":148,
                "endRoomTimeCount":782500351,
                "roomMemberCount":63,
                "roomMemberConcurrence":22,
                "statisticDate":"2023-01-13"
            },
            {
                "endRoomCount":71,
                "endRoomTimeCount":821220514,
                "roomMemberCount":43,
                "roomMemberConcurrence":23,
                "statisticDate":"2023-01-14"
            }
        ]
    }
}
此文档是否对你有帮助?
有帮助
去反馈
  • 接口请求地址
  • URL 中参数说明
  • 返回参数
  • 示例
  • 请求示例
  • 返回示例