You need to enable JavaScript to run this app.
导航

获取离线分布质量数据 ListQualityDistribution

最近更新时间2024.01.12 16:39:44

首次发布时间2022.12.16 20:05:32

你可以调用此接口查询一段时间内某个应用的音视频通话在不同维度的离线质量指标数据。

使用说明

接口行为

调用ListQualityDistribution 接口,指定 AppId、查询时间、指标名称和指标维度,获取不同维度(一级行政区/国家/设备平台/网络类型)的离线质量指标数据。

调用接口

关于调用接口的请求结构、公共参数、签名算法和返回结构,参看调用方法

注意事项

  • 最大请求次数:2 次/秒
  • 最远可查询时间:30 天
  • 最大单次查询时间跨度:7 天
  • 数据延迟:8 小时

请求说明

  • 请求方式:POST
  • 请求地址:https://rtc.volcengineapi.com?Action=ListQualityDistribution&Version=2020-12-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数

Query

参数类型是否必选示例值描述
ActionStringListQualityDistribution接口名称。当前 API 的名称为 ListQualityDistribution
VersionString2020-12-01接口版本。当前 API 的版本为 2020-12-01

Body

参数类型是否必选示例值描述
AppIdStringYour_AppId你的音视频应用的唯一标志。
StartTimeString2021-07-24T00:00:00+08:00查询起始时间戳,格式为 RFC3339,单位为秒。
EndTimeString2021-07-25T00:00:00+08:00查询结束时间戳,格式为 RFC3339,单位为秒。
IndicatorStringjoin_room_success_rate查询的指标名称,一次仅支持查询一个指标。Indicator 可选值,参看质量数据相关 indicator

Dimension

String

Province

查询维度,一次仅支持查询一个维度。
支持设为以下值:

  • Province:一级行政区(包括港澳台地区)
  • Country:国家
  • OS:用户设备平台
    包括:androidioslinuxmacwindows
  • Access:用户网络类型
    包括:2g3g4g5gwifi

ProductType

String

native

要查询的数据所属设备端,支持设为以下值:

  • native:指 Android、iOS、Linux、Mac、Windows 端。
  • web:指 Web 端。
    默认值为 native

返回参数

下表仅列出本接口特有的返回参数,公共返回参数请参见返回结构

参数类型示例值描述
IndicatorsArray of Indicator具体指标数据。

Indicator

参数类型示例值描述
NameString500ms_video_stall_rate指标名称。
DataArray of DataItem具体的指标数据。

DataItem

参数类型示例值描述
TimestampString2022-12-09T00:00:00+08:00指标聚合时间,即指标值对应时间段的开始时刻(每 1 天一聚合)。格式为 RFC3339 规范。
DimensionString丹麦具体的维度信息。
ValueFloat0.37指标数值,保留两位小数。

请求示例

POST https://rtc.volcengineapi.com?Action=ListQualityDistribution&Version=2020-12-01

{
    "AppId": "Your_AppId",
    "StartTime": "2022-12-09T00:00:00+08:00",
    "EndTime": "2022-12-10T00:00:00+08:00",
    "Indicator": "stall_rate",
    "ProductType": "native",
    "Dimension": "Country"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "Your_RequestId",
    "Action": "ListQualityDistribution",
    "Version": "2020-12-01",
    "Service": "rtc",
    "Region": "cn-north-1"
  },
  "Result": {
    "Indicators": [
      {
        "Name": "80ms_audio_stall_rate",
        "Data": [
          {
            "Timestamp": "2022-12-09T00:00:00+08:00",
            "Value": 0.54,
            "Dimension": "中国"
          },
          {
            "Timestamp": "2022-12-09T00:00:00+08:00",
            "Value": 0.43,
            "Dimension": "丹麦"
          },
          {
            "Timestamp": "2022-12-10T00:00:00+08:00",
            "Value": 0.52,
            "Dimension": "中国"
          },
          {
            "Timestamp": "2022-12-10T00:00:00+08:00",
            "Value": 0.38,
            "Dimension": "丹麦"
          }
        ]
      },
      {
        "Name": "500ms_video_stall_rate",
        "Data": [
          {
            "Timestamp": "2022-12-09T00:00:00+08:00",
            "Value": 0.45,
            "Dimension": "中国"
          },
          {
            "Timestamp": "2022-12-09T00:00:00+08:00",
            "Value": 0.47,
            "Dimension": "丹麦"
          },
          {
            "Timestamp": "2022-12-10T00:00:00+08:00",
            "Value": 0.62,
            "Dimension": "中国"
          },
          {
            "Timestamp": "2022-12-10T00:00:00+08:00",
            "Value": 0.37,
            "Dimension": "丹麦"
          }
        ]
      }
    ]
  }
}

错误码

您可访问公共错误码,获取更多错误码信息。