您可通过此接口获取主账号下指定时间范围内,开播并且已关播直播间的累计直播时长、最高同时在线人数和累计观看人次等离线数据。
说明
离线数据是指直播间创建后,某个时间范围内的数据,而不是直播间创建以来的所有历史数据。
请求频率:单用户请求频率限制为 1 次/秒。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ListAccountActivityHistoryData | 接口名称。当前 API 的名称为 ListAccountActivityHistoryData 。 |
Version | String | 是 | 2023-08-01 | 接口版本。当前 API 的版本为 2023-08-01 。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
PageSize | Integer | 否 | 20 | 分页查询数量,取值范围为 [1,1000],默认取值为 20 。 |
PageNumber | Integer | 否 | 1 | 分页查询页码,默认取值为 1 。 |
SortField | String | 否 |
| 排序维度。默认取值为
|
SortMode | String | 否 |
| 排序模式。默认取值为
|
StartLiveTime | Long | 是 |
| 查询起始时间。Unix 时间戳,单位为秒。 |
EndLiveTime | Long | 是 |
| 查询结束时间。Unix 时间戳,单位为秒。 |
PlayStatus | String | 否 |
| 根据以下维度进行筛选。默认取值为
|
ActivityName | String | 否 |
| 直播间名称。支持模糊搜索。最多支持输入 1,000 个字符。 |
SelectTags | Array of SelectTags | 否 | - | 根据分类标签信息进行筛选。您可以通过 ListSiteTagAPIV2 接口查询标签信息。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Index | Integer | 否 | 0 | 标签的索引值。用于标识标签在控制台展示的位置。索引值越小,位置越靠前。 |
Value | Array of String | 是 | ["标签值"] | 分类标签值。 |
Name | String | 否 | 标签名称 | 分类标签名称。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
PageSize | Integer | 20 | 分页查询数量。 |
TotalCount | Integer | 1 | 直播间总数量。 |
Activities | Array of Activities | - | 直播间统计信息。 |
PageNumber | Integer | 1 | 分页查询页码。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
ActivityId | Long | 17951838079243 | 直播间 ID。 |
ActivityName | String | 直播间 A | 直播间名称。 |
LiveTime | Long | 1712111173 | 直播间最近一次的开播时间。Unix 时间戳,单位为秒。 |
LiveDuration | Long | 1215 | 直播间的累计直播时长。单位为秒。 |
PV | Long |
| 累计观看次数/累计访问次数。 说明 如果观众刷新观看页 1 次,则人次新增 1 次。 |
UV | Long |
| 累计观看人数/累计访问人数。 说明 使用相同设备(即设备 ID 相同)观看或访问观看页的观众被判定为同一人,人数算作 1。例如 1 位观众使用设备 A 观看了 2 次、使用设备 B 观看了 1 次,1 位观众使用设备 C 观看了 3 次,则观看人数增加 3 人。 |
PCU | Long |
| 最高同时在线观看或访问人数。 说明 使用相同设备(即设备 ID 相同)观看或访问观看页的观众被判定为同一人,人数算作 1。 |
CommentCount | Long | 8 | 直播间的总聊天数以及弹幕口令数,包括主持人、观众、嘉宾、机器人发送的聊天数量(包括已删除评论和未通过聊天审核的评论等,但不包括图片评论),以及观众参与抽奖、红包等互动活动时发送的弹幕口令数。 |
WatchDurationPerPeople | Long |
| 人均观看时长/人均访问时长。单位为秒。
说明
|
LiveCount | Long | 4 | 直播场次,即直播间直播的次数。直播间的 1 次开关播,算作 1 个直播场次。单位为次。 |
LivePromotionLiveCount | Long | 4 | 转推场次,即直播间开启直播转推开关的直播场次数。一场直播中,无论转推到多少个第三方平台或账号、转推是否成功,转推场次均算作 1。单位为次。有关如何开启直播转推开关,详见直播转推。 |
LivePromotionLiveDuration | Long | 3514 | 转推时长,即直播间开启直播转推开关的直播场次的直播时长之和。单位为秒。有关如何开启直播转推开关,详见直播转推。1 个直播场次只要转推过,就以该场次完整直播时长计算。例如直播间 A 开启过 2 场直播且均开启了直播转推开关。其中第一场直播的时长为 3600 秒,转推 B 平台 1200 秒,转推 C 平台 3000 秒,则第一场直播的转推时长为 3600 秒。第二场直播的时长为 1800 秒,转推 D 平台 300 秒,则第二场直播的转推时长为 1800 秒。因此,直播间 A 的转推时长为 5400(36000+1800) 秒。 |
LivePromotionPlatformCount | Long |
| 转推平台数量,即直播间所有直播场次成功转推的平台数之和。单位为个。有关如何开启直播转推开关,详见直播转推。 说明
|
AppTemplateLiveCount | Long | 2 | 手机开播装修次数,即直播间使用 VolcLive 应用或 Android/iOS 开播 SDK 的挂件或图层(包括直播模板中的挂件和图层)功能进行装修的直播场次数。单位为次。有关如何使用挂件和图层功能,详见手机开播和 SDK 概览。 |
AppTemplateLiveDuration | Long | 687 | 手机开播装修时长,即直播间使用 VolcLive 应用或 Android/iOS 开播 SDK 的挂件或图层(包括直播模板中的挂件和图层)功能进行装修的直播场次的直播时长之和。单位为秒。有关如何使用挂件和图层功能,详见手机开播和 SDK 概览。 |
POST https://livesaas.volcengineapi.com/?Action=ListAccountActivityHistoryData&Version=2023-08-01 { "PageSize": 20, "SortField": "LiveTime", "SortMode": "desc", "StartLiveTime": 1711555260, "EndLiveTime": 1715115016, "PlayStatus": "All", "SelectTags": [ { "Index": 0, "Name": "标签名称", "Value": [ "标签值" ] } ], "ActivityName": "直播间 A", "PageNumber": 1 }
{ "ResponseMetadata": { "Action": "ListAccountActivityHistoryData", "Region": "cn-north-1", "RequestId": "2024041615203872B383A0A1B2B628CCA2", "Service": "livesaas", "SystemTime": 1713252039, "Version": "2023-08-01" }, "Result": { "Activities": [ { "ActivityId": 17951838079243, "ActivityName": "直播间 A", "AppTemplateLiveCount": 2, "AppTemplateLiveDuration": 687, "CommentCount": 8, "LiveCount": 4, "LiveDuration": 1215, "LivePromotionLiveCount": 4, "LivePromotionLiveDuration": 3514, "LivePromotionPlatformCount": 11, "LiveTime": 1712111173, "PCU": 10, "PV": 7, "UV": 5, "WatchDurationPerPeople": 4 } ], "PageNumber": 1, "PageSize": 20, "TotalCount": 1 } }
下表提供了该接口特有的错误码,公共错误码请参见公共错误码和错误码文档。
状态码 | 错误码 | 错误信息 | 说明 |
---|---|---|---|
400 | InvalidParameter.HistoryDataNotReady | The search end time needs to be less than today, otherwise the historical data has not been produced. | 离线数据尚未生成。请配置小于当前日期的结束时间。 |
400 | InvalidParameter.InvalidAccountId | The specified parameter AccountId is invalid. | 当前账号的鉴权信息错误。 |
400 | MissingParameter.StartLiveTimeNotFound | The required parameter StartLiveTime is missing. | 缺少必选参数 StartLiveTime 。请修改后重试。 |
400 | MissingParameter.EndLiveTimeNotFound | The required parameter EndLiveTime is missing. | 缺少必选参数 EndLiveTime 。请修改后重试。 |
500 | InternalError | Data search inner error, please try again. | 数据搜索服务出现内部错误。请重试。 |
400 | InvalidParameter.InvalidSelectTags | The select tag does not exist. Please confirm the parameter. | 分类标签不存在。请确认后重试。 |
400 | InvalidParameter.InvalidSelectTagValue | The value of select tag does not exist. Please confirm the parameter. | 分类标签值不存在。请确认后重试。 |