查询业务规模

描述

本接口支持查询指定时间段内每日的实时音视频数据统计，包括房间并发峰数、用户并发数、推拉流并发数及推拉流累计总数。

说明

查询时间段与您开通的套餐包中 数据存储和查询 有效期一致，详情请参考计费说明 - 套餐包功能。

接口原型

请求方法：GET
请求地址：https://analytics-api.zego.im/?Action=GetBizUsage
传输协议：HTTPS
调用频率限制（同一 AppID）：3 次/分，480 次/天

请求参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表请参考调用方式 - 公共请求参数。

参数	类型	是否必选	描述
StartDate	String	是	查询的起始日期，格式必须为 yyyyMMdd 的字符串格式。与 `EndDate` 配合使用时，二者所构成的日期区间不超过您开通的套餐包中数据存储和查询有效期，详情请参考计费说明 - 套餐包功能。
EndDate	String	是	查询的结束日期，格式必须为 yyyyMMdd 的字符串格式。
Metrics[]	Array of String	是	需要查询的指标，支持以下字符串： room_concurrent: 房间并发。 user_concurrent: 房间用户并发。 publish_concurrent：推流并发。 play_concurrent: 拉流并发。 publish_count: 推流累计。 play_count: 拉流累计。

请求示例

Untitled

https://analytics-api.zego.im/?Action=GetBizUsage
&StartDate=20250110
&EndDate=20250112
&Metrics[]=publish_count
&Metrics[]=play_count
&<公共请求参数>

Copied!

响应参数

参数	类型	描述
Code	Number	返回码。
Message	String	操作结果描述。
RequestId	String	请求 ID。
Data	Array	响应数据。
└Metrics	Array of Object	指标列表。
└Metric	String	指标名称。
└Values	Array of Object	指标值列表。
└Date	String	日期，格式为"yyyyMMdd"。
└Value	Number	指标值。

响应示例

Untitled

{
    "Code": 0,
    "Data": {
        "Metrics": [
            {
                "Metric": "publish_count",
                "Values": [
                    {
                        "Date": "20250110",
                        "Value": 100
                    },
                    {
                        "Date": "20250111",
                        "Value": 30
                    },
                    {
                        "Date": "20250112",
                        "Value": 40
                    }
                ]
            },
            {
                "Metric": "play_count",
                "Values": [
                    {
                        "Date": "20250110",
                        "Value": 60
                    },
                    {
                        "Date": "20250111",
                        "Value": 20
                    },
                    {
                        "Date": "20250112",
                        "Value": 10
                    }
                ]
            }
        ]
    },
    "Message": "success",
    "RequestId": 1659512998878671000
}

Copied!

返回码

返回码	说明	处理意见
0	成功。	-
500	接口错误。	请联系 ZEGO 技术支持。
10001	参数格式错误。	请检查参数。
10002	参数错误或参数无效。	请检查参数。
30002	接口请求频率超过上限。	请确认对应接口的 QPS 限制，降低请求频率。