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

获取主账号下的直播间统计数据

最近更新时间2024.03.01 14:04:34

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

获取主账号下直播间的累计直播时长、最高同时在线人数和累计观看人次等统计信息。

注意事项

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

请求说明

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

请求参数

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

Query

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

Body

参数类型是否必选示例值描述

PageToken

String

init

滚动查询 ID。滚动查询方式适用于查询 10,000 条以上数据的场景。
使用滚动查询方式时,首次调用接口查询数据时将该参数值设置为 init,第二次调用接口查询时将该参数值设置为首次查询返回参数中 PageToken 的值,第三次调用接口查询时将该参数值设置为第二次查询返回参数中 PageToken 的值,依次类推。当查询到最后分页,没有更多数据时,返回 finish

说明

  • 返回参数中 PageToken 值的失效时间为 3 分钟,即超过 3 分钟该 PageToken 值会失效,无法使用该值进行下一次查询。
  • 滚动查询过程中,请勿变更除 PageSize 参数外的查询条件,否则会导致接口查询失败。如需变更滚动查询条件,则需重新进行滚动查询。
PageSizeInteger20分页查询数量,取值范围为 [1,1000],默认取值为 20

PageNumber

Integer

1

分页查询页码,默认取值为 1

  • 使用滚动查询时,不需要传入该参数。
  • 未使用滚动查询时,接口最多支持返回 10,000 条查询结果,即 PageNumber×PageSize≤10,000。

SortField

String

LiveTime

排序维度。默认取值为 LiveTime

  • LiveTime:直播间设置的直播时间
  • LiveDuration:直播间的累计直播时长
  • PCU:最高同时在线人数。
  • UV:累计观看人数/累计访问人数
  • PV:累计观看次数/累计访问次数
  • CommentCount:直播间的总聊天数以及弹幕口令数
  • WatchDurationPerPeople:人均观看时长/人均访问时长

SortMode

String

desc

排序模式。默认取值为 desc

  • asc:升序
  • desc:降序

StartLiveTime

Long

1692339016

查询起始时间。Unix 时间戳,单位为秒。

说明

查询结束时间和起始时间的差值最大为 180 天,即 EndLiveTime - StartLiveTime ≤ 180 天(15,552,000 秒)。

EndLiveTime

Long

1700115016

查询结束时间。Unix 时间戳,单位为秒。

说明

查询结束时间和起始时间的差值最大为 180 天,即 EndLiveTime - StartLiveTime ≤ 180 天(15,552,000 秒)。

PlayStatus

String

ALL

根据以下维度进行筛选。默认取值为 All

  • All:观看直播、预告、回放的数据。
  • Live:观看直播的数据。
  • Preview:观看预告的数据。
  • Replay:观看回放的数据。
  • PageView:访问观看页的数据。
ActivityNameString直播间根据直播间名称进行筛选。支持模糊搜索。最多支持输入 1,000 个字符。
SelectTagsArray of SelectTags-根据分类标签信息进行筛选。您可以通过 ListSiteTagAPIV2 接口查询标签信息。

SelectTags

参数类型是否必选示例值描述
IndexInteger0标签的索引值。用于标识标签在控制台展示的位置。取值范围为 [0,19]。
ValueArray of String["标签值"]分类标签值。每个标签值最多为 20 个字符。
NameString标签名称分类标签名称。最多支持输入 8 个字符。

返回参数

参数类型示例值描述
PageTokenStringfinish滚动查询 ID。
PageSizeInteger20分页查询数量。
TotalCountInteger1直播间总数量。
ActivitiesArray of Activities-直播间统计信息。
PageNumberInteger1分页查询页码。

Activities

参数类型示例值描述
ActivityIdLong142489521562直播间 ID。
ActivityNameString直播间 A直播间名称。
LiveTimeLong1692559016直播间设置的直播时间。Unix 时间戳,单位为秒。
LiveDurationLong899直播间的累计直播时长。单位为秒。

PV

Long

412

累计观看次数/累计访问次数。

说明

如果观众刷新观看页 1 次,则人次新增 1 次。

UV

Long

286

累计观看人数/累计访问人数。

说明

使用相同设备(即设备 ID 相同)观看或访问观看页的观众被判定为同一人,人数算作 1。例如 1 位观众使用设备 A 观看了 2 次、使用设备 B 观看了 1 次,1 位观众使用设备 C 观看了 3 次,则观看人数增加 3 人。

PCU

Long

47

最高同时在线人数。

说明

使用相同设备(即设备 ID 相同)观看或访问观看页的观众被判定为同一人,人数算作 1。

CommentCountLong403直播间的总聊天数以及弹幕口令数,包括主持人、观众、嘉宾、机器人发送的聊天数量(包括已删除评论和未通过聊天审核的评论等,但不包括图片评论),以及观众参与抽奖、红包等互动活动时发送的弹幕口令数。

WatchDurationPerPeople

Long

476

人均观看时长/人均访问时长。单位为秒。PlayStatus 的取值不同,该参数的计算方式不同,具体如下:

  • All:累计观看直播、预告和回放的总时长 / 累计观看人数(UV)。
  • Live:累计观看直播时长 / 累计观看人数(UV)。
  • Preview:累计观看预告时长 / 累计观看人数(UV)。
  • Replay:累计观看回放时长 / 累计观看人数(UV)。
  • PageView:累计访问时长 / 累计访问人数(UV)。

说明

  • 累计观看时长指直播间内观众使用播放器观看的累计观看时长。例如 1 位观众观看了 1800 秒,1 位观众观看了 3600 秒,则累计观看时长增加 5400 秒。
  • 累计访问时长指直播间内观众访问观看页的累计页面访问时长。例如 1 位观众访问观看页 1800 秒,1 位观众访问观看页 3600 秒,则累计访问时长增加 5400 秒。

示例

请求示例

POST https://livesaas.volcengineapi.com/?Action=ListAccountActivityData&Version=2023-08-01
{
  "StartLiveTime": 1692339016,
  "EndLiveTime": 1700115016
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "ListAccountActivityData",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",        
        "SystemTime": 1700126287
    },
    "Result": {
      "PageToken": "",
      "Activities": [
        {
          "ActivityId": 142489521562,
          "ActivityName": "直播间 A",
          "LiveTime": 1692559016,
          "LiveDuration": 899,
          "PV": 412,
          "UV": 286,
          "PCU": 47,
          "WatchDurationPerPeople": 476,
          "CommentCount": 403
        }
      ],
      "TotalCount": 1,
      "PageSize": 20,
      "PageNumber": 1
        
    }
}

错误码

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

状态码错误码错误信息说明
400InvalidParameter.InvalidAccountIdThe specified parameter AccountId is invalid.当前账号的鉴权信息错误。
400MissingParameter.StartLiveTimeNotFoundThe required parameter StartLiveTime is missing.缺少必选参数 StartLiveTime。请修改后重试。
400MissingParameter.EndLiveTimeNotFoundThe required parameter EndLiveTime is missing.缺少必选参数 EndLiveTime。请修改后重试。
400InvalidParameter.InvalidSortFieldThe specified parameter SortField is invalid.SortField 参数不符合规范,请修改后重试。
400InvalidParameter.InvalidPlayStatusThe specified parameter PlayStatus is invalid.PlayStatus 参数不符合规范,请修改后重试。
400InvalidParameter.InvalidActivityNameThe specified parameter ActivityName is invalid.ActivityName 参数超过最大字符限制。请修改后重试。
400InvalidParameter.SearchSizeInvalidSearch scope is too large,please use PageToken search data more than 10,000.搜索数据超过 10,000 条,请使用 PageToken 进行滚动查询。
400InvalidParameter.PageTokenInvalidPageToken does not exist or expires. Please initialize the query againPageToken 参数值不存在或已过期。请使用 PageToken 重新进行滚动查询。
400InvalidParameter.PageTokenConditionModifyThe search condition change, PageToken cannot be used. Please initialize the query again.搜索条件变更,继续使用之前的 PageToken 返回值搜索会错误。请使用 PageToken 重新进行滚动查询。
500InternalErrorData search inner error, please try again.数据搜索服务出现内部错误。请重试。
400InvalidParameter.InvalidSelectTagsThe select tag does not exist. Please confirm the parameter.分类标签不存在。请确认后重试。
400InvalidParameter.InvalidSelectTagValueThe value of select tag does not exist. Please confirm the parameter.分类标签值不存在。请确认后重试。