获取离线运营指标维度分布数据 ListOperationDistribution--实时音视频-火山引擎

文档中心

立即注册

导航

实时音视频

获取离线运营指标维度分布数据 ListOperationDistribution

最近更新时间：2024.07.10 11:35:59首次发布时间：2022.12.15 21:47:44

你可以调用此接口查询一段时间内，某个应用的音视频通话在地域维度的离线运营质量指标数据。

使用说明

接口行为

调用ListOperationDistribution接口，指定 AppId、查询起止时间、指标名称和指标维度，获取地域维度（一级行政区/国家）的离线运营指标数据（目前仅支持查询通话人数）。

注意事项

最大请求次数：2 次/秒
可查询时间范围：最近 30 天
单次查询时间范围：不超过 7 天
数据延迟：8 小时

请求说明

请求方式：POST
请求地址：https://rtc.volcengineapi.com?Action=ListOperationDistribution&Version=2020-12-01

调试

API Explorer

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

去调试

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`ListOperationDistribution`	接口名称。当前 API 的名称为 `ListOperationDistribution`。
Version	String	是	`2020-12-01`	接口版本。当前 API 的版本为 `2020-12-01`。

Body

参数	类型	是否必选	示例值	描述
AppId	String	是	`Your_AppId`	你的音视频应用的唯一标志。
StartTime	String	是	`2021-07-24T00:00:00+08:00`	查询起始时间戳，格式为 RFC3339，单位为秒。
EndTime	String	是	`2021-07-26T00:00:00+08:00`	查询结束时间戳，格式为 RFC3339，单位为秒。
Indicator	String	是	`user_count`	查询的指标名称。目前仅支持查询 `user_num`，即此 AppId 在所选日期的通话总人数。通话人数按用户 id 去重。
Dimension	String	是	`province`	查询维度。目前仅支持查询: 一级行政区（包括港澳台地区）国家

返回参数

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

参数	类型	示例值	描述
Name	String	`user_num`	指标名称
Data	Object[]		具体的指标值以及对应时间
DistributionName	String	`上海`	维度名
Value	Double	`666.00`	指标值
Proportion	Double	`66.66`	占比
Dimension	String	`province`	查询维度

请求示例

POST https://rtc.volcengineapi.com?Action=ListOperationDistribution&Version=2020-12-01
{
  "AppId": "Your_AppId",
  "StartTime": "2021-07-24T00:00:00+08:00",
  "EndTime": "2021-07-26T00:00:00+08:00",
  "Indicator": "user_count",
  "Dimension": "province"
}

返回示例

{
    "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,
                "Proportion": 66.66
            },
            {
                "DistributionName": "北京",
                "Value": 123,
                "Proportion": 12.31
            }
        ]
    }
}

错误码

您可访问公共错误码，获取更多错误码信息。