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

接口行为

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

接口限制

限制类别	调用频率限制
请求次数	每分钟 10 次每天 1440 次
可查询时间范围	最近 60 分钟
单次查询时间范围	60 分钟
数据延时	1 分钟

请求方式

使用 POST 方式发起请求。

请求参数

Query

参数名	类型	必填	示例值	描述
Action	String	是	`ListRealTimeQualityDistribution`	接口名称，本接口取值：`ListRealTimeQualityDistribution`
Version	String	是	`2020-12-01`	接口版本，本接口取值：`2020-12-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`

请求示例代码

Query

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

Body

{
    "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

返回参数

返回结果参看 BaseResponse。其中 Result 的结构如下：

参数名	类型	描述
Indicators	Array of Indicator	具体指标数据

Indicator

参数名	类型	示例值	描述
Name	string	`5s_join_room_success_rate`	指标名称
Data	Array of DataItem		具体的指标值以及对应时间

DataItem

参数名	类型	描述
Timestamp	String	指标聚合时间，即指标值对应时间段的开始时刻（每 30s 一聚合）。格式为 RFC3339 规范。
Dimension	String	具体的维度信息。
Value	float	指标数值，保留两位小数。

返回调用结果

正常返回示例

{
    "ResponseMetadata":{
        "RequestId":"Your_RequestId",
        "Action":"ListRealTimeQualityDistribution",
        "Version":"2020-12-01",
        "Service":"rtc",
        "Region":"cn-north-1"
    },
    "Result":{
        "Indicators": [
            {
                "Name": "5s_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

错误码

若调用此接口失败，你会在相应结果中看到错误码和错误信息。处理错误码的方法参看错误码。