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

接口行为

你可以调用 ListQuality 接口，指定你所属的 AppId，指标类型和查询时间段，查询该时间段内指标的数据。

调用接口

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

接口限制

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

请求方式

使用 POST 方式发起请求。

请求参数

Query

参数名	类型	必填	示例值	描述
Action	String	是	`ListQuality`	接口名称，本接口取值：`ListQuality`
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	Array of String	是	`["stall_rate","join_room_success_rate"]`	查询的指标名称。可同时查询多个指标。Indicator 可选值，参看质量数据相关 indicator。
AggregateGranularity	String	是	`1d`	返回聚合时间的粒度，支持设为以下值： `1d`：粒度为 1 天 `5min`：粒度为 5 分钟
ProductType	String	否	`native`	要查询的产品类型，取值为 `native` 和 `web`。 `native`：指 `android`、`iOS`、`linux`、`mac`或 `windows` 平台的 veRTC SDK。 `web`：指 Web 平台的veRTC SDK。默认值为`native`
OS	Array of String	否	`iOS`	可取值：`android`、`iOS`、`linux`、`mac`、`windows` `ProductType` = `web` 时该参数不生效
Access	Array of String	否	`2g`	网络类型，可取值：`2g`、`3g`、`4g`、`5g`、`wifi` `ProductType` = `web` 时该参数不生效
RoomId	String	否	`Your_RoomId`	房间 ID。如果不填，代表查询该 `AppId` 的整体离线指标。
UserId	Array of String	否	`["user1","user2"]`	查询的用户 ID 列表，最多可以指定 20 个。值不合法时默认剔除。此字段仅在 RoomId 不为空时生效。

请求示例代码

Query

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

Body

{
    "AppId" : "Your_AppId",
    "StartTime" : "2021-07-24T00:00:00+08:00",
    "EndTime" : "2021-07-28T00:00:00+08:00",
    "Indicator":["stall_rate","join_room_success_rate"],
    "ProductType":"native",
    "AggregateGranularity":"1d",
    "OS":["ios","linux"],
    "Access":["2g","3g"],
    "RoomId":"Your_RoomId",
    "UserId":"Your_UserId"     
}
json

返回调用结果

返回参数说明

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

参数名	类型	示例值	描述
AggregateGranularity	String	`1d`	返回数据的粒度
Indicators	Array of Indicator	`AudioStallDuration`	具体指标数据

Indicator

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

DataItem

参数名	类型	示例值	描述
TimeStamp	string	`2021-07-24T00:00:00+08:00`	指标聚合时间，即指标值对应时间段的开始时刻。可通过设置`AggregateGranularity`选择返回聚合时间的粒度。格式为 RFC3339 规范。
Value	double	`99.99`	指标值，浮点数，保留两位小数。

正常返回示例

{
    "ResponseMetadata":{
        "RequestId":"Your_RequestId",
        "Action":"ListQuality",
        "Version":"2020-12-01",
        "Service":"rtc",
        "Region":"cn-north-1"
    },
    "Result":{
        "AggregateGranularity":"1d",
        "Indicators":[
            {
                "Name":"5s_join_room_success_rate",
                "Unit":"%",
                "Data":[
                    {
                        "TimeStamp":"2021-07-24T00:00:00+08:00",
                        "Value":98.68
                    },
                    {
                        "TimeStamp":"2021-07-25T00:00:00+08:00",
                        "Value":98.20
                    }
                ]
            },
            {
                "Name":"10s_join_room_success_rate",
                "Unit":"%",
                "Data":[
                    {
                        "TimeStamp":"2021-07-24T00:00:00+08:00",
                        "Value":99.68
                    },
                    {
                        "TimeStamp":"2021-07-25T00:00:00+08:00",
                        "Value":99.20
                    }
                ]
            }
        ]
    }
}
json