文档中心
Analytics_Dashboard 星图
文档中心
体验 App
SDK 中心
API 中心
常见问题
代码市场
进入控制台
立即注册
登录
中文站 English
  • 文档中心
  • 星图
  • 服务端 API
  • 运营大盘
  • 查询质量趋势

查询质量趋势

更新时间:2025-02-08 10:08

描述

本接口支持查询指定时间段内每日的实时音视频质量指标,包括卡顿率、首帧耗时、推流成功率、拉流成功率、房间登录成功率,以及 5 秒内房间登录成功率。

查询时间段与您开通的套餐包中 数据存储和查询 有效期一致,详情请参考 计费说明 - 套餐包功能。

接口原型

  • 请求方法:GET
  • 请求地址:https://analytics-api.zego.im/?Action=GetBizQuality
  • 传输协议:HTTPS
  • 调用频率限制(同一 AppID):3 次/分,480 次/天

请求参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表请参考 调用方式 - 公共请求参数。

参数 类型 是否必选 描述
StartDate
String
是
查询的起始日期,格式必须为 yyyyMMdd 的字符串格式。
与 EndDate 配合使用时,二者所构成的日期区间不超过您开通的套餐包中 数据存储和查询 有效期,详情请参考 计费说明 - 套餐包功能。
EndDate
String
是
查询的结束日期,格式必须为 yyyyMMdd 的字符串格式。
Metrics[]
Array of String
是
需要查询的指标,支持以下字符串:
  • break_rate: 卡顿率。
  • fft: 首帧耗时,单位为毫秒。
  • login_consumed: 进房耗时,单位为毫秒。
  • publish_success_rate_cdn: CDN 推流成功率。
  • publish_success_rate_rtc: RTC 推流成功率。
  • play_success_rate_cdn: CDN 拉流成功率。
  • play_success_rate_l3: L3 拉流成功率。
  • play_success_rate_rtc: RTC 拉流成功率。
  • login_success_rate:房间登录成功率。
  • login_success_5s:5秒内登录房间成功率。

请求示例

https://analytics-api.zego.im/?Action=GetBizQuality
&StartDate=20250110
&EndDate=20250112
&Metrics[]=fft
&<公共请求参数>

响应参数

参数 类型 描述
Code
Number
返回码。
Message
String
操作结果描述。
RequestId
String
请求 ID。
Data
Array
响应数据。
Metrics
Array of Object
指标列表。
Metric
String
指标名称。
Values
Array of Object
指标值列表。
Date
String
日期,格式为"yyyyMMdd"。
Value
Number
指标值。

响应示例

{
    "Code": 0,
    "Data": {
        "Metrics": [
            {
                "Metric": "fft",
                "Values": [
                    {
                        "Date": "20250110",
                        "Value": 60
                    },
                    {
                        "Date": "20250111",
                        "Value": 20
                    },
                    {
                        "Date": "20250112",
                        "Value": 10
                    }
                ]
            }
        ]
    },
    "Message": "success",
    "RequestId": 1659512998878671000
}

返回码

返回码 说明 处理意见
0 成功。 -
500 接口错误。 请联系 ZEGO 技术支持。
10001 参数格式错误。 请检查参数。
10002 参数错误或参数无效。 请检查参数。
30002 接口请求频率超过上限。 请确认对应接口的 QPS 限制,降低请求频率。
本篇目录
  • 免费试用
  • 提交工单
    咨询集成、功能及报价等问题
    电话咨询
    400 1006 604
    咨询客服
    微信扫码,24h在线

    联系我们

  • 文档反馈