文档中心

实时音视频

请输入

历史数据查询

获取离线质量指标数据 ListQuality

本文档 API 接口为最新版本接口，后续相关功能的新增都会在此更新，推荐使用最新版本接口。旧版接口文档请参考历史版本。

调用 ListQualityDistribution 接口，查询应用在指定时间范围内的离线质量指标数据。可查询离线指标数据可参看质量数据相关指标。

若要查询地域分布、设备平台、网络类型等维度的离线质量数据，建议调用 ListQualityDistribution 接口。

注意事项

最大请求次数：2次/秒

最远可查询时间：30 天

最大单次查询时间跨度：7 天

数据粒度：1 天或 5 分钟

数据延迟：8 小时

请求说明

请求方式：POST

请求地址：https://rtc.volcengineapi.com?Action=ListQuality&Version=2023-11-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

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

Query

Action String 必选示例值：ListQuality

接口名称。当前 API 的名称为 ListQuality。

Version String 必选示例值：2023-11-01

接口版本。当前 API 的版本为 2023-11-01。

Body

AppId String 必选示例值：66****3cf

实时音视频应用的 AppId。可在控制台获取。

StartTime String 必选示例值：2021-07-24T00:00:00+08:00

查询起始时间戳，格式为 RFC3339，单位为秒。

EndTime String 必选示例值：2021-07-28T00:00:00+08:00

查询结束时间戳，格式为 RFC3339，单位为秒。

Indicator String[] 必选示例值：["stall_rate","join_room_success_rate"]

查询的指标名称。可同时查询多个指标。Indicator 可选值，参看质量数据相关 indicator。

AggregateGranularity String 必选示例值：1d

返回聚合时间的粒度，支持取值及含义如下：

1d：粒度为 1 天

5min：粒度为 5 分钟

OS String[] 可选示例值：["ios","linux"]

操作系统：android、iOS、linux、mac、windows

注意

ProductType = web时该参数不生效。

Access String[] 可选示例值：["2g","3g"]

网络类型：2g、3g、4g、5g、wifi

ProductType = web 时该参数不生效

RoomId String 可选示例值：Room1

房间 ID。如果不填，代表查询该 AppId 的整体离线指标。

UserId String[] 可选示例值：User1

查询的用户 ID 列表，最多可以指定 20 个。值不合法时默认剔除。此字段仅在 RoomId 不为空时生效。

ProductType String 可选示例值：native

SDK 所属平台：

native（默认值）： android、iOS、linux、mac或 windows 平台的 SDK。

web：Web SDK。

返回参数

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

AggregateGranularity String 示例值：1d

返回数据的粒度。

Indicators Object[] 示例值：AudioStallDuration

指标信息。

Data Object[] 示例值：-

指标详细数据。

Value Double 示例值：99.99

指标值，浮点数，保留两位小数。

TimeStamp String 示例值：2021-07-24T00:00:00+08:00

指标聚合时间，即指标值对应时间段的开始时刻（每 30s 一聚合）。格式为 RFC3339 规范。

StreamId String 示例值：stream1

流 ID。

Name String 示例值：pull_num

指标名称。

Unit String 示例值：-

指标单位。

请求示例

返回示例

最近更新时间：2026.03.13 10:26:43

这个页面对您有帮助吗？

有用

无用