You need to enable JavaScript to run this app.
文档中心
实时音视频

实时音视频

复制全文
下载 pdf
历史数据查询
获取离线分布质量数据 ListQualityDistribution
复制全文
下载 pdf
获取离线分布质量数据 ListQualityDistribution
本文档 API 接口为最新版本接口,后续相关功能的新增都会在此更新,推荐使用最新版本接口。旧版接口文档请参考历史版本。​
在实时音视频通话场景中,你可以调用此接口查询特定应用在指定时间段内的离线质量指标数据。​
查询 RTC 应用在指定时间段内,按特定维度(如地区、设备平台、网络类型)切分的离线质量指标数据。该接口适用于对质量数据进行细分分析,以排查特定地域或设备的体验问题。可查询指标数据可参看质量数据相关 indicator。​
注意事项​
  • 最大请求次数:2 次/秒​
  • 最远可查询时间:30 天​
  • 最大单次查询时间跨度:7 天​
  • 数据延迟:8 小时​
请求说明​
  • 请求方式:POST​
  • 请求地址:https://rtc.volcengineapi.com?Action=ListQualityDistribution&Version=2023-11-01​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。​
Query​
Action String 必选 示例值:ListQualityDistribution​
接口名称。当前 API 的名称为 ListQualityDistribution。​
​
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-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​
​
Platform String 可选 示例值:iOS​
设备平台,目前支持 Android、iOS 和 Web。​
​
ProductType String 可选 示例值:native​
要查询的数据所属设备端,支持取值及含义如下:​
  • native(默认值):指 Android、iOS、Linux、Mac 或 Windows 端。​
  • web:指 Web 端。​
​
​
返回参数​
下表仅列出本接口特有的返回参数,公共返回参数请参见返回结构。​
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=ListQualityDistribution&Version=2023-11-01​
{​
"AppId": "661e7ae5543cf",​
"StartTime": "2022-12-09T00:00:00+08:00",​
"EndTime": "2022-12-10T00:00:00+08:00",​
"Indicator": "stall_rate",​
"ProductType": "native",​
"Dimension": "Country"​
}​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "20230604110420",​
"Action": "ListQualityDistribution",​
"Version": "2023-11-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": "丹麦"​
}​
]​
}​
]​
}​
}​
​
错误码​
您可访问公共错误码,获取更多错误码信息。​
最近更新时间:2026.08.19 18:32:18
这个页面对您有帮助吗?
有用
有用
无用
无用