你可以调用此接口查询一段时间内,某个应用的音视频通话在地域维度的离线运营质量指标数据。
调用ListOperationDistribution接口,指定 AppId、查询起止时间、指标名称和指标维度,获取地域维度(一级行政区/国家)的离线运营指标数据(目前仅支持查询通话人数)。
关于调用接口的服务地址、通信协议、字符编码和签名机制,参看调用OpenAPI。
| 限制类别 | 调用频率限制 |
|---|---|
| 请求次数 | |
| 可查询时间范围 | 最近 30 天 |
| 单次查询时间范围 | 不超过 7 天 |
| 数据延迟 | 8 小时 |
使用 POST 方式发起请求。
| 参数名 | 类型 | 必填 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | ListOperationDistribution | 接口名称,本接口取值:ListOperationDistribution |
| Version | String | 是 | 2020-12-01 | 接口版本,本接口取值:2020-12-01 |
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
| AppId | String | 是 | 你的音视频应用的唯一标志。 |
| StartTime | String | 是 | 查询起始时间戳,格式为 RFC3339,单位为秒。 |
| EndTime | String | 是 | 查询结束时间戳,格式为 RFC3339,单位为秒。 |
| Indicator | String | 是 | 查询的指标名称。 目前仅支持查询 user_num,即此 AppId 在所选日期的通话总人数。通话人数按用户 id 去重。 |
| Dimension | String | 是 | 查询维度。目前仅支持查询: |
https://rtc.volcengineapi.com?Action=ListOperationDistribution&Version=2020-12-01
postscript{
"AppId" : "Your_AppId",
"StartTime" : "2021-07-24T00:00:00+08:00",
"EndTime" : "2021-07-26T00:00:00+08:00",
"Indicator":"user_count",
"Dimension": "province"
}
json返回结果参看 BaseResponse。
其中 Result 的结构如下:
| 参数名 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Name | string | user_num | 指标名称 |
| Data | Array of DataItem | 具体的指标值以及对应时间 |
DataItem
| 参数名 | 类型 | 描述 |
|---|---|---|
| DistributionName | string | 具体的维度信息。 |
| Proportion | float | 该维度下指标数值占比,单位是 %,保留两位小数。 |
| Value | float | 指标数值,保留两位小数。 |
{
"ResponseMetadata":{
"RequestId":"Your_RequestId",
"Action":"ListOperationDistribution",
"Version":"2020-12-01",
"Service":"rtc",
"Region":"cn-north-1"
},
"Result":{
"Name":"user_num",
"Dimension": "province",
"Data":[
{
"DistributionName":"上海",
"Value":666.00,
"Proportion":66.66
},
{
"DistributionName":"北京",
"Value":123.00,
"Proportion":12.31
}
]
}
}
json