You need to enable JavaScript to run this app.
导航

获取主账号下的核心统计数据

最近更新时间2023.11.23 14:40:38

首次发布时间2023.11.23 14:40:38

获取主账号下的直播间总数量、累计观看人次和累计观看人数等核心统计数据。

注意事项

请求频率:单用户请求频率限制为 10 次/秒

请求说明

  • 请求方式:GET
  • 请求地址:https://livesaas.volcengineapi.com/?Action=GetAccountAggregatedStatistics&Version=2023-08-01

请求参数

Query

参数类型是否必选示例值描述
ActionStringGetAccountAggregatedStatistics接口名称。当前 API 的名称为 GetAccountAggregatedStatistics
VersionString2023-08-01接口版本。当前 API 的版本为 2023-08-01

TimeRange

String

7day

支持查询以下时间范围的统计数据。

  • 7day:最近 7 天
  • 30day:最近 30 天
  • 90day:最近 90 天
  • 180day:最近 180 天

返回参数

参数类型示例值描述
LiveCountInteger55直播场次,即主账号下查询时间范围内创建的直播间总数量。

WatchTime

Integer

390

累计观看人次,即主账号下查询时间范围内所有直播间的观看人次(PV)之和。
单个直播间的观看人次指直播间内观众使用播放器观看的累计观看次数。例如 1 位观众观看了 2 次,1 位观众观看了 1 次,则观看人次增加 3 次。

说明

如果观众在使用播放器观看期间,刷新观看页 1 次,则观看人次新增 1 次。

WatchPeople

Integer

200

累计观看人数,即主账号下查询时间范围内所有直播间的观看人数(UV)之和。
单个直播间的观看人数指直播间内观众使用播放器观看的累计观看人数。使用相同设备(即设备 ID 相同)观看的观众被判定为同一人,人数算作 1。例如 1 位观众使用设备 A 观看了 2 次、使用设备 B 观看了 1 次,1 位观众使用设备 C 观看了 3 次,则观看人数增加 3 人。

WatchLivePerPeople

Double

2

人均观看场次,即主账号下查询时间范围内使用播放器观看的观众人均观看场次,即累计观看人数(所有直播间的观看人数(UV)之和) / 总观看人数。
总观看人数指对主账号下的所有观看人数进行设备去重,即使用相同设备(即设备 ID 相同)观看的观众被判定为同一人,人数算作 1。

WatchTimePerPeople

Double

30

人均观看时长,即主账号下查询时间范围内使用播放器观看的观众人均观看时长,即所有直播间的累计观看时长之和 / 累计观看人数(所有直播间的观看人数(UV)之和)。单位为秒。
单个直播间的累计观看时长指直播间内观众使用播放器观看的累计观看时长。例如 1 位观众观看了 1800 秒,1 位观众观看了 3600 秒,则累计观看时长增加 5400 秒。

WatchCountPerPeople

Double

1.5

人均观看次数,即主账号下查询时间范围内使用播放器观看的观众人均观看次数,即所有直播间的人均观看次数之和 / 直播场次。
单个直播间的人均观看次数指直播间内观众使用播放器观看的人均观看次数,即观看人次(PV)/ 观看人数(UV)。

示例

请求示例

GET https://livesaas.volcengineapi.com/?Action=GetAccountAggregatedStatistics&Version=2023-08-01&TimeRange=7day

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202306041104200100100232280022D31",
    "Action": "GetAccountAggregatedStatistics",
    "Version": "2023-08-01",
    "Service": "livesaas",
    "Region": "cn-north-1",
    "SystemTime": 1672890452
  },
  "Result": {
    "LiveCount": 55,
    "WatchTime": 390,
    "WatchPeople": 200,
    "WatchLivePerPeople": 2,
    "WatchTimePerPeople": 30,
    "WatchCountPerPeople": 1.5
  }
}

错误码

下表提供了该接口特有的错误码,公共错误码请参见公共错误码错误码文档。

状态码错误码错误信息说明
400InvalidParameter.AccountIdInvalidThe specified parameter AccountId is invalid.当前账号的鉴权信息错误。
400MissingParameter.TimeRangeNotFoundThe required parameter TimeRange is missing.缺少必选参数 TimeRange。请修改后重试。
400InvalidParameter.InvalidTimeRangeThe specified parameter TimeRange is invalid.TimeRange 参数取值错误。请修改后重试。
500InternalErrorData search inner error, please try again.数据搜索服务出现内部错误。请重试。