查询聚合质量指标

开发者中心

指南针

服务端 API

查询聚合质量指标

更新时间： 2025/02/14 16:31:03

获取指定时间范围内，指定维度下的聚合质量指标。

请求

URI

GET https://data.netease.im/data/v3/compass/nrtc/quality/aggregation

路径参数

参数	类型	是否必填	描述
metric	String	是	聚合的指标名称。枚举值： login_success_rate（进房成功率） login_success_rate_5s（5s进房成功率） video_stuck_rate（视频卡顿率） audio_stuck_rate（音频卡顿率） audio_network_delay（音频网络延时） video_network_delay（视频网络延时） audio_first_frame_duration（音频首帧时长） video_first_frame_duration（视频首帧时长）
start_time	Long	是	开始时间。Unix 时间戳，单位：毫秒（ms）。时间范围不超过30天
end_time	Long	是	结束时间。Unix 时间戳，单位：毫秒（ms）。时间范围不超过30天
dimension	String	是	纬度值。枚举值： country（国家） province（省份） sdk_version（sdk版本） device（设备型号） room_size（房间规模） platform（操作系统）

请求示例

curl --location 'https://{{endpoint}}/data/v3/nrtc/quality/aggregation?metric=login_success_rate&start_time=1697385600000&end_time=1697904000000&dimension=platform'
--header 'X-custom-traceid:91629c975c4f269a6fc67bf9da0609be' \
--header 'AppKey:b2efc79xxxxxxx155e7d2' \
--header 'Nonce:8dfdb33d2840' \
--header 'CurTime:1443592222' \
--header 'CheckSum:b404199cdb06d20991bc6e758f40c007dc61016d' \
--header 'Content-Type:application/json; charset=utf-8'

响应

响应字段

字段	类型	描述
code	Integer	响应状态码。200 表示请求成功
msg	String	错误信息
request_id	String	请求 ID
- data	Array of objects	响应数据
dimension_value	String	维度值
metric_value	String	指标值。卡顿率、成功率相关指标为百分数，并保留两位小数；网络延时、首帧时长相关指标为整数
samples	Long	采样值

响应示例

json{
    "code":200,
    "data":[
        {
            "dimension_value":"Android",
            "metric_value":"0.36",
            "samples":3205727299
        },
        {
            "dimension_value":"iOS",
            "metric_value":"0.29",
            "samples":390049815
        }
    ],
    "request_id":"2621a4f9d6034b5baede6caa9ccf9c85"
}

此文档是否对你有帮助？

有帮助

去反馈

请求
URI
路径参数
请求示例
响应
响应字段
响应示例