您可通过此接口获取指定观众的累计观看数据、互动数据及观看足迹等详细信息。
注意事项
请求频率：单用户请求频率限制为 1 次/秒。
请求说明
- 请求方式：POST
- 请求地址：https://livesaas.volcengineapi.com/?Action=GetAccountUserTrackData&Version=2023-08-01
请求参数
下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。
Query
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|
| Action | String | 是 | GetAccountUserTrackData | 接口名称。当前 API 的名称为 GetAccountUserTrackData。 |
| Version | String | 是 | 2023-08-01 | 接口版本。当前 API 的版本为 2023-08-01。 |
Body
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|
| Index | Integer | 否 | 0 | 标签的索引值。用于标识标签在控制台展示的位置。索引值越小，位置越靠前。 |
| Value | Array of String | 是 | ["标签值"] | 分类标签值。 |
| Name | String | 否 | 标签名称 | 分类标签名称。 |
返回参数
| 参数 | 类型 | 示例值 | 描述 |
|---|
| UserTrackData | Object of UserTrackData | - | 完整的观众用户画像详情。 |
FilterUserTrack | Object of FilterUserTrack | -
| 筛选后的观众用户画像详情。 说明 通过 ActivityId 或 SelectTags 进行筛选时，该参数返回筛选后的观众用户画像详情，否则该参数为空。 |
UserTrackData
FilterUserTrack
UserTracks
| 参数 | 类型 | 示例值 | 描述 |
|---|
| ActivityId | Long | 178***12348 | 直播间 ID。 |
| ActivityName | String | 直播间 A | 直播间名称。 |
| JoinTime | Long | 1681800648 | 进入直播间的时间。Unix 时间戳，单位为秒。 |
| WatchDurationLive | Integer | 600 | 观看直播的时长。单位为秒。 |
| WatchDurationReplay | Integer | 300 | 观看回放的时长。单位为秒。 |
| CommentCount | Integer | 868 | 发送的评论数量（包括已删除评论和未通过聊天审核的评论等，但不包括图片评论）以及参与抽奖、红包等互动活动时发送的弹幕口令数。 |
| LotteryAwards | Array of String | ["实物抽奖"] | 在实时抽奖中获得的奖品名称列表。 |
| PayAmount | String | 2 | 付费金额。 |
UserTrackSum
| 参数 | 类型 | 示例值 | 描述 |
|---|
| WatchCount | Integer | 6 | 观众累计观看的直播间数量。 |
| WatchDuration | Integer | 170843 | 观众访问观看页的累计页面访问时长。单位为秒。 |
InteractData
| 参数 | 类型 | 示例值 | 描述 |
|---|
| ReservationCount | Integer | 1 | 观众预约直播的次数。 |
| VoteCount | Integer | 2 | 观众参与投票的次数。 |
| CommentCount | Integer | 89 | 观众发送的评论数量（包括已删除评论和未通过聊天审核的评论等，但不包括图片评论）以及参与抽奖、红包等互动活动时发送的弹幕口令数。 |
| QuestionnaireCount | Integer | 7 | 观众填写问卷的次数。 |
| LotteryCount | Integer | 1 | 观众参与实时抽奖的次数。 |
| LotteryHitCount | Integer | 1 | 观众中奖的次数。 |
| InviteCount | Integer | 1 | 观众分享直播的次数，即有多少用户通过观众分享的专属链接、二维码或海报进入并登录直播间。 |
| ShiftScreenNumber | Integer | 1 | 观众触发切屏检测提醒弹窗的次数。 |
| MuteNumber | Integer | 0 | 观众触发静音停播提醒弹窗的次数。 |
| NoInteractNumber | Integer | 1 | 观众触发无互动检测提醒弹窗的次数。 |
| ThumbUpNumber | Long | 1 | 观众的直播间点赞数量。 |
| CouponPickupCount | Long | 1 | 观众领取的卡券数量。 |
PayData
| 参数 | 类型 | 示例值 | 描述 |
|---|
| TotalAmount | String | 2 | 付费金额。 |
| PayCount | Integer | 1 | 付费观看次数。 |
请求示例
POST https://livesaas.volcengineapi.com/?Action=GetAccountUserTrackData&Version=2023-08-01
{
"UserId": 178215489,
"ActivityId":178452648,
"SelectTags": [
{
"Index": 0,
"Value": ["标签值"],
"Name":"标签名称"
}
]
}
返回示例
{
"ResponseMetadata": {
"RequestId": "20230604110420****100232280022D31",
"Action": "GetAccountUserTrackData",
"Version": "2023-08-01",
"Service": "livesaas",
"Region": "cn-north-1",
"SystemTime": 1700125666
},
"Result": {
"UserTrackData": {
"UserTracks": [
{
"ActivityId": 178****12348,
"ActivityName": "直播间 A",
"JoinTime": 1681800648,
"WatchDurationLive": 600,
"WatchDurationReplay": 300,
"CommentCount": 868,
"PayAmount": "2",
"LotteryAwards": [
"实物抽奖"
]
}
],
"PayData": {
"TotalAmount": "2",
"PayCount": 1
},
"InteractData": {
"ReservationCount": 1,
"MuteNumber": 0,
"NoInteractNumber": 1,
"ShiftScreenNumber": 1,
"InviteCount": 1,
"LotteryHitCount": 1,
"LotteryCount": 1,
"QuestionnaireCount": 7,
"CommentCount": 89,
"VoteCount": 2,
"ThumbUpNumber": 1,
"CouponPickupCount": 1
},
"UserTrackSum": {
"WatchCount": 6,
"WatchDuration": 170843
}
},
"FilterUserTrack": {
"UserTracks": [
{
"ActivityId": 178****12348,
"ActivityName": "直播间 A",
"JoinTime": 1681822654,
"WatchDurationLive": 600,
"WatchDurationReplay": 300,
"CommentCount": 86,
"PayAmount": "2",
"LotteryAwards": [
"实物抽奖"
]
}
],
"PayData": {
"TotalAmount": "2",
"PayCount": 1
},
"InteractData": {
"ReservationCount": 1,
"MuteNumber": 0,
"NoInteractNumber": 1,
"ShiftScreenNumber": 1,
"InviteCount": 1,
"LotteryHitCount": 1,
"LotteryCount": 1,
"QuestionnaireCount": 7,
"CommentCount": 89,
"VoteCount": 2,
"ThumbUpNumber": 1,
"CouponPickupCount": 1
},
"UserTrackSum": {
"WatchCount": 6,
"WatchDuration": 170843
}
}
}
}
错误码
下表提供了该接口特有的错误码，公共错误码请参见公共错误码和错误码文档。
| 状态码 | 错误码 | 错误信息 | 说明 |
|---|
| 400 | InvalidParameter.InvalidAccountId | The specified parameter AccountId is invalid. | 当前账号的鉴权信息错误。 |
| 400 | InvalidParameter.InvalidUserId | The specified parameter UserId is invalid. | UserId 参数不符合规范，请修改后重试。 |
| 500 | InternalError | Data search inner error, please try again. | 数据搜索服务出现内部错误。请重试。 |