查看地区质量实时数据
描述
查询指定地区（或所有地区）和指定平台（或所有平台）上 1 小时时间跨度内的质量数据，按分钟粒度返回。
接口原型
- 请求方法：GET
- 请求地址：
https://analytics-api.zego.im/?Action=GetRegionQualityDetail - 传输协议：HTTPS
- 调用频率限制（同一 AppID）：3 次/分，480 次/天
- 数据延迟：3分钟
请求参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表请参考 调用方式 - 公共请求参数。
| 参数 | 类型 | 是否必选 | 描述 |
|---|---|---|---|
| Region | String | 否 | 国家或地区的名称。
|
| Platform | String | 否 | 平台类型。
注意 有些指标可能不支持平台类型维度，返回值可能为空。 |
| StartTs | Number | 是 | 开始时间，UTC 时间戳，单位为毫秒。 |
| EndTs | Number | 是 | 结束时间，UTC 时间戳，单位为毫秒。如果推流未结束，则可以用 0 或者当前时间戳表示进行中。 |
请求示例
https://analytics-api.zego.im/?Action=GetRegionQualityDetail
&Region=中国
&Platform=all
&StartTs=1659411617260000
&EndTs=1659415320000
&<公共请求参数>响应参数
| 参数 | 类型 | 描述 |
|---|---|---|
| Code | Number | 返回码。 |
| Message | String | 操作结果描述。 |
| RequestId | String | 请求 ID。 |
| Data | Object | 响应数据。 |
| └List | Array of Object | 指标列表。 |
| └Timestamp | Number | UTC 时间戳，单位为毫秒。 |
| └QualityInfo | Array of Object | 质量列表。 |
| └Region | String | 国家或地区的名称。 |
| └P2pDelayDetail | Object | 端到端延迟。 |
| └Total | Number | 分钟样本总数量。 |
| └Rate1 | Number | 在 (0, 400ms) 区间数量占比。 |
| └Rate2 | Number | 在 [400ms, 600ms) 区间数量占比。 |
| └Rate3 | Number | 在 [600ms, 800ms) 区间数量占比。 |
| └Rate4 | Number | 在 800ms 及以上数量占比。 |
| └P2pPlrDetail | Array of Object | 端到端丢包率分布。 |
| └Total | Number | 分钟样本总数量。 |
| └Rate1 | Number | 丢包率为 0 的数量占比。 |
| └Rate2 | Number | 丢包率在 (0, 5%) 的数量占比。 |
| └Rate3 | Number | 丢包率在 [5%, 10%) 的数量占比。 |
| └Rate4 | Number | 丢包率在 [10%, 50%) 的数量占比。 |
| └Rate5 | Number | 丢包率在 [50%, 100%]的数量占比。 |
| └VideoBreakDetail | Array of Object | 视频卡顿率分布。 |
| └Total | Number | 分钟样本总数量。 |
| └Rate1 | Number | 卡顿率为 0 的数量占比。 |
| └Rate2 | Number | 卡顿率在 (0, 20%) 的数量占比。 |
| └Rate3 | Number | 卡顿率在 [20%, 50%) 的数量占比。 |
| └Rate4 | Number | 卡顿率在 [50%, 100%) 的数量占比。 |
| └Rate5 | Number | 卡顿率在 100% 的数量占比。 |
| └AudioBreakDetail | Array of Object | 音频卡顿率分布。 |
| └Total | Number | 分钟样本总数量。 |
| └Rate1 | Number | 卡顿率为 0 的数量占比。 |
| └Rate2 | Number | 卡顿率在 (0, 20%) 的数量占比。 |
| └Rate3 | Number | 卡顿率在 [20%, 50%) 的数量占比。 |
| └Rate4 | Number | 卡顿率在 [50%, 100%) 的数量占比。 |
| └Rate5 | Number | 卡顿率在 100% 的数量占比。 |
| └LoginSuccessRateDetail | Array of Object | 登录成功率。 |
| └LoginSuccessRate | Number | 登录成功率。 |
| └LoginSuccessRate5s | Number | 5 秒内登录成功率。 |
| └VideoFFTDetail | Array of Object | 视频首帧耗时分布。 |
| └Total | Number | 分钟样本总数量。 |
| └Rate1 | Number | 耗时在 (0, 500ms] 的数量占比。 |
| └Rate2 | Number | 耗时在 (500ms, 1000ms] 的数量占比。 |
| └Rate3 | Number | 耗时在 (1000ms, 2000ms] 的数量占比。 |
| └Rate4 | Number | 耗时在 (2000, 5000ms] 的数量占比。 |
| └Rate5 | Number | 卡顿率在 5000ms 以上的数量占比。 |
| └AudioFFTDetail | Array of Object | 音频首帧耗时分布。 |
| └Total | Number | 分钟样本总数量。 |
| └Rate1 | Number | 耗时在 (0, 500ms] 的数量占比。 |
| └Rate2 | Number | 耗时在 (500ms, 1000ms] 的数量占比。 |
| └Rate3 | Number | 耗时在 (1000ms, 2000ms] 的数量占比。 |
| └Rate4 | Number | 耗时在 (2000, 5000ms] 的数量占比。 |
| └Rate5 | Number | 卡顿率在 5000ms 以上的数量占比。 |
响应示例
{
"Code": 0,
"Data": {
"List": [
{
"Timestamp": 1676961480000,
"QualityInfo": [
{
"Region": "中国",
"P2pDelayDetail": {
"Total": 298,
"Rate1": 0.9966,
"Rate2": 0,
"Rate3": 0,
"Rate4": 0.0034
},
"P2pPlrDetail": {
"Total": 1123,
"Rate1": 0.9386,
"Rate2": 0.0561,
"Rate3": 0.0018,
"Rate4": 0.0036,
"Rate5": 0
},
"VideoBreakDetail": {
"Total": 920,
"Rate1": 0.9304,
"Rate2": 0.0022,
"Rate3": 0.0109,
"Rate4": 0.0446,
"Rate5": 0.012
},
"AudioBreakDetail": {
"Total": 1123,
"Rate1": 0.951,
"Rate2": 0.016,
"Rate3": 0.0107,
"Rate4": 0.0098,
"Rate5": 0.0125
},
"LoginSuccessRateDetail": {
"LoginSuccessRate": 1,
"LoginSuccessRate5s": 1
},
"VideoFFTDetail": {
"Total": 39,
"Rate1": 0.9231,
"Rate2": 0,
"Rate3": 0.0513,
"Rate4": 0.0256,
"Rate5": 0
},
"AudioFFTDetail": {
"Total": 36,
"Rate1": 0.9167,
"Rate2": 0.0278,
"Rate3": 0.0556,
"Rate4": 0,
"Rate5": 0
}
}
]
},
{
"Timestamp": 1676961540000,
"QualityInfo": [
{
"Region": "中国",
"P2pDelayDetail": {
"Total": 298,
"Rate1": 0.9966,
"Rate2": 0,
"Rate3": 0,
"Rate4": 0.0034
},
"P2pPlrDetail": {
"Total": 1123,
"Rate1": 0.9386,
"Rate2": 0.0561,
"Rate3": 0.0018,
"Rate4": 0.0036,
"Rate5": 0
},
"VideoBreakDetail": {
"Total": 920,
"Rate1": 0.9304,
"Rate2": 0.0022,
"Rate3": 0.0109,
"Rate4": 0.0446,
"Rate5": 0.012
},
"AudioBreakDetail": {
"Total": 1123,
"Rate1": 0.951,
"Rate2": 0.016,
"Rate3": 0.0107,
"Rate4": 0.0098,
"Rate5": 0.0125
},
"LoginSuccessRateDetail": {
"LoginSuccessRate": 1,
"LoginSuccessRate5s": 1
},
"VideoFFTDetail": {
"Total": 39,
"Rate1": 0.9231,
"Rate2": 0,
"Rate3": 0.0513,
"Rate4": 0.0256,
"Rate5": 0
},
"AudioFFTDetail": {
"Total": 36,
"Rate1": 0.9167,
"Rate2": 0.0278,
"Rate3": 0.0556,
"Rate4": 0,
"Rate5": 0
}
}
]
}
]
},
"Message": "success"
}返回码
| 返回码 | 说明 | 处理意见 |
|---|---|---|
| 0 | 成功。 | - |
| 500 | 接口错误。 | 请联系 ZEGO 技术支持。 |
| 10001 | 参数格式错误。 | 请检查参数。 |
| 10002 | 参数错误或参数无效。 | 请检查参数。 |
| 30002 | 接口请求频率超过上限。 | 请确认对应接口的 QPS 限制，降低请求频率。 |