调用 GetPageWatchDataAPIV2
接口获取指定直播间的基础数据,包括累计访问或观看次数、人数、时长及最高同时在线人数等。数据每分钟更新一次。
请求频率:单用户请求频率限制为 1,000 次/分钟。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | GetPageWatchDataAPIV2 | 接口名称。当前 API 的名称为 GetPageWatchDataAPIV2 。 |
Version | String | 是 | 2020-06-01 | 接口版本。当前 API 的版本为 2020-06-01 。 |
ActivityId | Long | 是 | 1770****83012 | 直播间 ID。您可通过调用 ListActivityAPI 接口获取 ID。 |
Channel | String | 否 | 1 | 渠道标识。默认获取所有渠道的数据。您可通过调用 ListChannelAPI 接口获取渠道标识。 |
PlayStatus | Integer | 否 |
| 根据直播状态进行筛选。默认值为
|
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
ActivityId | Long | 1770****83012 | 直播间 ID。 |
PageClicks | Object of 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=1770****83012&Channel=1&PlayStatus=10
{ "ResponseMetadata": { "RequestId": "20230604110420****100232280022D31", "Action": "GetPageWatchDataAPIV2", "Version": "2020-06-01", "Service": "livesaas", "Region": "cn-north-1", "SystemTime": 1672890452 }, "Result": { "ActivityId": 1770****83012, "PageClicks": { "PV": 10, "UV": 5, "TotalTime": 20, "AvgTime": 4, "AvgNumber": 2, "PCU": 5 } } }