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

获取实时分布质量数据 ListRealTimeQualityDistribution

最近更新时间2024.02.27 15:01:13

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

你可调用此接口查询一段时间内,某个应用的音视频通话在地域分布、设备平台、网络类型等维度的实时质量指标数据。

使用说明

接口行为

调用ListRealTimeQualityDistribution接口,指定 AppId、查询时间、指标名称和指标维度,获取地域分布、设备平台、网络类型等维度的实时质量指标数据。

调用接口

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

注意事项

  • 最大请求次数:2 次/秒
  • 可查询时间范围:最近 60 分钟
  • 单次查询时间范围:60 分钟
  • 数据延时:1 分钟

请求说明

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

请求参数

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

Query

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

Body

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

Dimension

String

Province

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

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

返回参数

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

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

Indicator

参数类型示例值描述
NameString5s_join_room_success_rate指标名称
DataArray of DataItem具体的指标值以及对应时间

DataItem

参数类型示例值描述
ValueDouble99.06指标数值,保留两位小数。
DimensionStringwindows具体的维度信息。
TimeStampString2022-12-12T14:00:30+08:00指标聚合时间,即指标值对应时间段的开始时刻(每 30s 一聚合)。格式为 RFC3339 规范。

请求示例

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

{
    "AppId": "Your_AppId",
    "StartTime": "2022-12-12T14:00:00+08:00",
    "EndTime": "2022-12-12T14:01:00+08:00",
    "Indicator": "join_room_success_rate",
    "Dimension": "OS"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "Your_RequestId",
    "Action": "ListRealTimeQualityDistribution",
    "Version": "2020-12-01",
    "Service": "rtc",
    "Region": "cn-north-1"
  },
  "Result": {
    "Indicators": [
      {
        "Name": "join_room_success_rate",
        "Data": [
          {
            "Timestamp": "2022-12-12T14:00:00+08:00",
            "Value": 99.05,
            "Dimension": "windows"
          },
          {
            "Timestamp": "2022-12-12T14:00:00+08:00",
            "Value": 99.24,
            "Dimension": "ios"
          },
          {
            "Timestamp": "2022-12-12T14:00:00+08:00",
            "Value": 99.12,
            "Dimension": "android"
          },
          {
            "Timestamp": "2022-12-12T14:00:00+08:00",
            "Value": 99.83,
            "Dimension": "mac"
          },
          {
            "Timestamp": "2022-12-12T14:00:00+08:00",
            "Value": 100,
            "Dimension": "linux"
          },
          {
            "Timestamp": "2022-12-12T14:00:30+08:00",
            "Value": 99.82,
            "Dimension": "mac"
          },
          {
            "Timestamp": "2022-12-12T14:00:30+08:00",
            "Value": 99.49,
            "Dimension": "linux"
          },
          {
            "Timestamp": "2022-12-12T14:00:30+08:00",
            "Value": 98.98,
            "Dimension": "android"
          },
          {
            "Timestamp": "2022-12-12T14:00:30+08:00",
            "Value": 99.15,
            "Dimension": "ios"
          },
          {
            "Timestamp": "2022-12-12T14:00:30+08:00",
            "Value": 99.06,
            "Dimension": "windows"
          }
        ]
      }
    ]
  }
}

错误码

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