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

使用说明
接口行为

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

调用接口

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

注意事项
请求说明
请求参数
Query
参数名称
数据类型
是否必选
示例值
描述
Action
String
是
ListRealTimeQualityDistribution
接口名称。当前 API 的名称为 ListRealTimeQualityDistribution。
Version
String
是
2023-11-01
接口版本。当前 API 的版本为 2023-11-01。
Body
参数
类型
是否必选
示例值
描述
AppId
String
是
Your_AppId
你的音视频应用的唯一标志。
StartTime
String
是
2022-12-12T14:00:00+08:00
查询起始时间戳，格式为 RFC3339，单位为秒。
EndTime
String
是
2022-12-12T14:10:00+08:00
查询结束时间戳，格式为 RFC3339，单位为秒。
Indicator
String
是
join_room_success_rate
查询的指标名称。一次仅支持查询一个指标。Indicator 可选值，参看质量数据相关 indicator。
Dimension
String
是
Province

查询的维度，一次仅支持查询一个维度。

支持设为以下值：

  • Province：
    一级行政区（包括港澳台地区）
  • Country：国家
  • OS：用户设备平台
    包括：android、ios、linux、mac、windows
  • Access：用户网络类型
    包括：2g、3g、4g、5g、wifi
Platform
String
否
设备平台，目前支持 Android、iOS和 Web。
ProductType
String
否

要查询的产品类型，枚举值为 native 和 web。

  • native：指 android、iOS、linux、mac或 windows 平台的 veRTC SDK。
  • web：指 Web 平台的veRTC SDK。 默认值为native
返回参数

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

参数
类型
示例值
描述
Indicators
Object[]
具体指标数据
Data
Object[]
具体的指标值以及对应时间
Value
Double
99.06
指标数值，保留两位小数。
Dimension
String
windows
具体的维度信息。
TimeStamp
String
2022-12-12T14:00:30+08:00
指标聚合时间，即指标值对应时间段的开始时刻（每 30s 一聚合）。格式为 RFC3339 规范。
Name
String
5s_join_room_success_rate
指标名称
请求示例 
POST https://rtc.volcengineapi.com?Action=ListRealTimeQualityDistribution&Version=2023-11-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"
}

json
返回示例 
{
  "ResponseMetadata": {
    "RequestId": "Your_RequestId",
    "Action": "ListRealTimeQualityDistribution",
    "Version": "2023-11-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"
          }
        ]
      }
    ]
  }
}

json