文档中心
星图
服务端 API
明细数据
查看用户推拉流基本信息

查看用户推拉流基本信息

更新时间：2025-02-08 10:08

描述

查询用户在指定时间段内与指定房间 ID 和流 ID 相关的基本信息。

接口原型

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

请求参数

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

参数	类型	是否必选	描述
RoomId	String	是	房间 ID。
UserId	String	是	用户 ID。
StreamId	String	是	流 ID。
StreamType	String	是	流的类型： `publish`：推流。 `play`：拉流。
StartTs	Number	是	开始时间，UTC 时间戳，单位为毫秒。
EndTs	Number	是	结束时间，UTC 时间戳，单位为毫秒。如果推流未结束，则可以用 0 或者当前时间戳表示进行中。

请求示例

https://analytics-api.zego.im/?Action=GetStreamBaseInfo
&RoomId=room
&UserId=userA
&StreamId=streamA
&StreamType=publish
&StartTs=1672565276000
&EndTs=1672565456000
&<公共请求参数>

响应参数

参数	类型	描述
Code	Number	返回码。
Message	String	操作结果描述。
RequestId	String	请求 ID。
Data	Object	响应数据。
Metrics	Array of Object	指标列表。
Metric	String	指标名，可能为下列名称： isp：网络服务提供商。 net_type：网络类型。 os_type：设备类型。 device_model：设备名称。 sdk_version：SDK 版本。 region：国家或地区。
Values	Array of Object	指标值列表。
Value	String	指标值。当 `Metric` 为 `net_type` 时，此字段为下列固定内容： 2G: 2G 网络。 3G: 3G 网络。 4G: 4G 网络。 5G: 5G 网络。 WIFI: 无线网络。 LINE: 有线网络。 NONE: 无网络连接。 UNKNOWN: 网络类型未能识别。当 `Metric` 为其他值时，此字段内容不固定。
Timestamp	Number	UTC 时间戳，单位为毫秒。

响应示例

{
    "Code": 0,
    "Message": "success",
    "Data": {
        "Metrics": [
            {
                "Metric": "net_type",
                "Values": [
                    {
                        "Timestamp": 1660634097767,
                        "Value": "WIFI"
                    }
                ]
            }
        ]
    },
    "RequestId": 1660645050860325000
}

返回码

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