查询时序质量指标

更新时间不可用

按分钟、小时或天的时间粒度获取指定时间范围内的质量指标,包括加入频道成功率、5s 加入频道成功率、音频卡顿率、视频卡顿率、网络延迟率。

GET
https://api.sd-rtn.com/beta/insight/quality/by_time

鉴权

Authorization

使用声网 RESTful API 的凭证。发送请求时,你需要使用声网提供的客户 ID 和客户密钥生成一个使用 Base64 算法编码的凭证,并填入 HTTP 请求头部的 Authorization 字段。详见使用 HTTP 认证。

查询参数

startTsnumber
必填

查询的时间范围起点,Unix 时间戳(秒)。响应中会包含起点所在的时间窗口。

endTsnumber
必填

查询的时间范围终点,Unix 时间戳(秒)。响应中不会包含终点所在的时间窗口。

appidstring
必填

你的项目使用的 App ID。

metricstring
必填

要查询的指标,支持设为以下值:

  • joinSuccessRate:加入频道成功率。
  • joinSuccessIn5sRate:5s 内加入频道成功率。
  • audioFreezeRate:音频卡顿率。
  • videoFreezeRate:视频卡顿率。
  • networkDelay :网络延迟率。
aggregateGranularitystring
必填

返回数据的粒度,支持设为以下值:

  • 1d:按天。此时返回查询时间范围内以 UTC 时间为零点起始的一整天的数据。
  • 1h:按小时。此时返回查询时间范围内 UTC 时间为整小时的数据。
productTypestring
必填

要查询的产品类型,支持设为以下值:

  • Native:指 Android、iOS、macOS、Windows 平台的声网 RTC SDK。
  • WebRTC:指 Web 平台的声网 RTC SDK。

响应

OK

响应 Body

字段
codenumber

响应状态码。200 表示请求成功,详见响应状态码。

messagestring

错误消息。

请求示例

Example Request
curl --request GET \
  --url "https://api.sd-rtn.com/beta/insight/quality/by_time?startTs=1631837410&endTs=1631837470&appid=string&metric=string&aggregateGranularity=string&productType=string" \
  --header 'Authorization: Basic <credentials>'

响应示例

{
  "code": 200,
  "message": "success",
  "data": [
    {
      "networkDelay": 0.064762,
      "ts": 1625097600
    },
    {
      "networkDelay": 0.028156,
      "ts": 1625101200
    },
    {
      "networkDelay": 0.03765,
      "ts": 1625184000
    }
  ]
}