获取直播间基础数据--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

获取直播间基础数据

最近更新时间：2024.09.04 17:25:19首次发布时间：2023.02.01 10:13:18

您可通过此接口获取指定直播间的基础数据，包括累计访问或观看次数、人数、时长及最高同时在线人数等。数据每分钟更新一次。

注意事项

请求频率：单用户请求频率限制为 1000 次/分钟。

请求说明

请求方式：GET
请求地址：https://livesaas.volcengineapi.com/?Action=GetPageWatchDataAPIV2&Version=2020-06-01

请求参数

以下请求参数列表仅列出了该接口的部分公共参数，完整公共参数列表见公共请求参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetPageWatchDataAPIV2`	接口名称。当前 API 的名称为 `GetPageWatchDataAPIV2`。
Version	String	是	`2020-06-01`	接口版本。当前 API 的版本为 `2020-06-01`。
ActivityId	Long	是	`1770637083012`	直播间 ID。您可以通过调用 ListActivityAPI 接口查询 ID。
Channel	String	否	`1`	根据渠道标识进行筛选。您可以通过调用 ListChannelAPI 接口查询渠道标识，默认查询全部渠道数据。
PlayStatus	Integer	否	`10`	根据直播状态进行筛选。支持以下取值，默认取值为 `10` 1：直播观看 2：预告观看 3：回放观看 10：页面访问（页面停留） 11：总观看

返回参数

参数	类型	示例值	描述
ActivityId	Long	`1770637083012`	直播间 ID
PageClicks	Array of PageClicks	`-`	直播间基础数据

PageClicks

参数	类型	示例值	描述
PV	Integer	`10`	直播间内观众访问观看页的累计访问次数或使用播放器观看的累计观看次数。
UV	Integer	`5`	直播间内观众访问观看页的累计访问人数或使用播放器观看的累计观看人数。使用相同设备（即设备 ID 相同）访问观看页或观看的观众被判定为同一人，人数算作 1。
TotalTime	Integer	`20`	直播间内观众访问观看页的累计页面访问时长或使用播放器观看的累计观看时长，单位分钟。
AvgTime	Float	`4`	直播间内观众访问观看页的人均访问时长或使用播放器观看的人均观看时长，即累计访问时长或观看时长（`TotalTime` ）/ 访问人数或观看人数（`UV`），单位分钟。
AvgNumber	Float	`2`	直播间内观众访问观看页的人均访问次数或使用播放器观看的人均观看次数，即访问人次或观看人次（`PV`）/ 访问人数或观看人数（`UV`）。
PCU	Integer	`5`	直播间内观众访问观看页或使用播放器观看的最高同时在线人数。使用相同设备（即设备 ID 相同）访问观看页或观看的观众被判定为同一人，人数算作 1。

示例

请求示例

GET https://livesaas.volcengineapi.com/?Action=GetPageWatchDataAPIV2&Version=2020-06-01&ActivityId=1770637083012&Channel=1&PlayStatus=10

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20230105114732391C1BEC3323BD4BD5E0",
    "Action": "GetPageWatchDataAPIV2",
    "Version": "2020-06-01",
    "Service": "livesaas",
    "Region": "cn-north-1",
    "SystemTime": 1672890452
  },
  "Result": {
    "ActivityId": 1770637083012,
    "PageClicks": {
      "PV": 10,
      "UV": 5,
      "TotalTime": 20,
      "AvgTime": 4,
      "AvgNumber": 2,
      "PCU": 5
    }
  }
}

错误码

访问公共错误码获取详细信息。