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

接口行为

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

调用接口

关于调用接口的服务地址、通信协议、字符编码和签名机制，参看调用OpenAPI。

接口限制

限制类别	调用频率限制
最大请求次数	2 次/秒
最远可查询时间	30 天
最大单次查询时间跨度	7 天
数据延迟	8 小时

请求方式

使用 POST 方式发起请求。

请求参数

Query

参数名	类型	必填	示例值	描述
Action	String	是	`ListQualityDistribution`	接口名称，本接口取值：`ListQualityDistribution`
Version	String	是	`2020-12-01`	接口版本，本接口取值：`2020-12-01`

Body

参数名	类型	必填	示例值	描述
AppId	String	是	`Your_AppId`	你的音视频应用的唯一标志。
StartTime	String	是	`2021-07-24T00:00:00+08:00`	查询起始时间戳，格式为 RFC3339，单位为秒。
EndTime	String	是	`2021-07-25T00:00: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`
ProductType	String	否	native	要查询的数据所属设备端，支持设为以下值： `native`：指 Android、iOS、Linux、Mac、Windows 端。 `web`：指 Web 端。默认值为 `native`。

请求示例代码

Query

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

Body

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

返回调用结果

返回参数说明

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

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

Indicator

参数名	类型	示例值	描述
Name	string	`5s_join_room_success_rate`	指标名称。
Data	Array of DataItem		具体的指标数据。

DataItem

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

正常返回示例

{
    "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": "丹麦"
                    },
                ]
            }
        ]
    }
}
json

错误码

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