查询实时质量

描述

本接口可用于获取最近 2 小时内指定时间区间的实时音视频卡顿率、上下行延时、端到端延迟、推拉流成功率以及房间登录成功率。返回数据为分钟粒度。

接口原型

请求方法：GET
请求地址：https://analytics-api.zego.im/?Action=GetRealtimeQuality
传输协议：HTTPS
调用频率限制（同一 AppID）：3 次/分，480 次/天
数据延迟：3分钟

请求参数

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

参数	类型	是否必选	描述
Metrics[]	Array of String	是	需要查询的指标 video_break_rate: 视频卡顿率 audio_break_rate: 音频卡顿率 uplink_rtt：上行延迟 downlink_rtt：下行延迟 peer_to_peer_delay：端到端延迟 publish_success_rate: 推流成功率 play_success_rate: 拉流成功率 login_success_rate：房间登录成功率
StartTs	Number	是	开始时间，UTC 时间戳，单位为毫秒。
EndTs	Number	是	结束时间，UTC 时间戳，单位为毫秒。如果推流未结束，则可以用 0 或者当前时间戳表示进行中。

请求示例

https://analytics-api.zego.im/?Action=GetRealtimeQuality
&Metrics[]=video_break_rate
&Metrics[]=audio_break_rate
&StartTs=1672565260000
&EndTs=1672565320000
&<公共请求参数>

https://analytics-api.zego.im/?Action=GetRealtimeQuality
&Metrics[]=video_break_rate
&Metrics[]=audio_break_rate
&StartTs=1672565260000
&EndTs=1672565320000
&<公共请求参数>

响应参数

参数	类型	描述
Code	Number	返回码。
Message	String	操作结果描述。
RequestId	String	请求 ID。
Data	Array	响应数据。
└Metrics	Array of Object	指标列表。
└Metric	String	指标名称。
└Values	Array of Object	指标值列表。
└Timestamp	Number	时间戳，单位为毫秒。
└Value	Number	指标值。

响应示例

{
  "Code": 0,
  "Message": "success",
  "Data": {
    "Metrics": [
      {
        "Metric": "video_break_rate",
        "Values": [
          {
            "Timestamp": 1660634260000,
            "Value": 0.1
          },
          {
            "Timestamp": 1660634320000,
            "Value": 0.12
          }
        ]
      },
      {
        "Metric": "audio_break_rate",
        "Values": [
          {
            "Timestamp": 1660634260000,
            "Value": 0.03
          },
          {
            "Timestamp": 1660634320000,
            "Value": 0.05
          }
        ]
      }
    ]
  },
  "RequestId": 1660645050860325000
}

{
  "Code": 0,
  "Message": "success",
  "Data": {
    "Metrics": [
      {
        "Metric": "video_break_rate",
        "Values": [
          {
            "Timestamp": 1660634260000,
            "Value": 0.1
          },
          {
            "Timestamp": 1660634320000,
            "Value": 0.12
          }
        ]
      },
      {
        "Metric": "audio_break_rate",
        "Values": [
          {
            "Timestamp": 1660634260000,
            "Value": 0.03
          },
          {
            "Timestamp": 1660634320000,
            "Value": 0.05
          }
        ]
      }
    ]
  },
  "RequestId": 1660645050860325000
}

返回码

返回码	说明	处理意见
0	成功。	-
500	接口错误。	请联系 ZEGO 技术支持。
10001	参数格式错误。	请检查参数。
10002	参数错误或参数无效。	请检查参数。
30002	接口请求频率超过上限。	请确认对应接口的 QPS 限制，降低请求频率。