获取离线运营数据 ListOperationData--实时音视频-火山引擎

文档中心

立即注册

导航

实时音视频

获取离线运营数据 ListOperationData

最近更新时间：2024.11.05 15:49:29首次发布时间：2024.02.27 14:52:18

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

在实时音视频通话场景中，你可以通过调用此接口获取应用在指定时间段内的离线运营数据。

若要查询地域维度的离线运营质量数据（通话人数），建议调用ListOperationDistribution 接口。

可查询指标数据可参看离线运营数据相关 indicator。

注意事项

最大请求次数：2 次/秒
最远可查询时间：30 天
最大单次查询时间跨度：7 天
数据延迟：8 小时

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
AppId	String	是	`661e****543cf`	你的音视频应用的唯一标志，参看获取 AppId。
StartTime	String	是	`2021-07-24T00:00:00+08:00`	查询起始时间戳，格式为 RFC3339，单位为秒。
EndTime	String	是	`2021-07-25T00:00:00+08:00`	查询结束时间戳，格式为 RFC3339，单位为秒。
Indicator	String[]	是	`["per_call_time","avg_call_time"]`	查询的指标名称。可同时查询多个指标。Indicator 可选值，参看离线运营数据相关 indicator。
AggregateGranularity	String	是	`1d`	返回聚合时间的粒度，支持取值及含义如下： `1d`：粒度为 1 天 `1h`：粒度为 1 小时

返回参数

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

参数	类型	示例值	描述
Indicators	Object[]	`-`	具体指标数据
Data	Object[]	`-`	具体的指标值以及对应时间
Value	Double	`99.99`	指标值，浮点数，保留两位小数。指标值，浮点数，保留两位小数。
TimeStamp	String	`2021-07-24T00:00:00+08:00`	指标聚合时间，即指标值对应时间段的开始时刻（每 30s 一聚合）。格式为 RFC3339 规范。指标聚合时间，即指标值对应时间段的开始时刻（每 30s 一聚合）。格式为 RFC3339 规范。
Name	String	`5s_join_room_success_rate`	指标名称
AggregateGranularity	String	`1d`	返回聚合时间的粒度

请求示例

POST https://rtc.volcengineapi.com?Action=ListOperationData&Version=2023-11-01
{
    "AppId": "661e****543cf",
    "StartTime": "2021-07-24T00:00:00+08:00",
    "EndTime": "2021-07-25T00:00:00+08:00",
    "Indicator": [
        "per_call_time",
        "avg_call_time"
    ],
    "AggregateGranularity": "1d"
}

返回示例

{
    "ResponseMetadata":{
        "RequestId":"20230604110420",
        "Action":"ListOperationData",
        "Version":"2023-11-01",
        "Service":"rtc",
        "Region":"cn-north-1"
    },
    "Result":{
        "AggregateGranularity" : "1d",
        "Indicators":[
            {
                "Name":"per_call_time",
                "Data":[
                    {
                        "TimeStamp":"2021-07-24T00:00:00+08:00",
                        "Value":98.62
                    },
                    {
                        "TimeStamp":"2021-07-25T00:00:00+08:00",
                        "Value":98.67
                    }
                ]
            },
            {
                "Name":"avg_call_time",
                "Data":[
                    {
                        "TimeStamp":"2021-07-24T00:00:00+08:00",
                        "Value":99.61
                    }
                    {
                        "TimeStamp":"2021-07-25T00:00:00+08:00",
                        "Value":99.69
                    }
                ]
            }
        ]
    }
}