最近更新时间:2023.11.23 14:40:38
首次发布时间:2023.11.23 14:40:38
获取主账号下的所有观众的用户画像详情。
请求频率:单用户请求频率限制为 1 次/秒。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | GetAccountUserTrackData | 接口名称。当前 API 的名称为 GetAccountUserTrackData 。 |
Version | String | 是 | 2023-08-01 | 接口版本。当前 API 的版本为 2023-08-01 。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
UserId | Long | 是 | 1***9 | 观众在企业直播的唯一标识。您可以通过 ListAccountUserData 接口查询 ID。 |
ActivityId | Long | 否 | 178***48 | 直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。 |
SelectTags | Array of SelectTags | 否 | - | 根据分类标签信息进行筛选。您可以通过 ListSiteTagAPIV2 接口查询标签信息。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Index | Integer | 否 | 0 | 标签的索引值。用于标识标签在控制台展示的位置。取值范围为 [0,19]。 |
Value | Array of String | 是 | ["标签值"] | 分类标签值。每个标签值最多为 20 个字符。 |
Name | String | 否 | 标签名称 | 分类标签名称。最多支持输入 8 个字符。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
UserTrackData | Object of UserTrackData | - | 完整的观众用户画像详情。 |
FilterUserTrack | Object of FilterUserTrack |
| 筛选后的观众用户画像详情。 说明 通过 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
UserTracks | Array of UserTracks | - | 观看足迹。 |
UserTrackSum | Object of UserTrackSum | - | 累计观看数据。 |
InteractData | Object of InteractData | - | 互动数据。 |
PayData | Object of PayData | - | 付费数据。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
UserTracks | Array of UserTracks | - | 观看足迹。 |
UserTrackSum | Object of UserTrackSum | - | 累计观看数据。 |
InteractData | Object of InteractData | - | 互动数据。 |
PayData | Object of PayData | - | 付费数据。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
ActivityId | Long | 178***48 | 直播间 ID。 |
ActivityName | String | 直播间 A | 直播间名称。 |
JoinTime | Long | 1681800648 | 进入直播间的时间。Unix 时间戳,单位为秒。 |
WatchDurationLive | Integer | 600 | 观看直播的时长。单位为秒。 |
WatchDurationReplay | Integer | 300 | 观看回放的时长。单位为秒。 |
CommentCount | Integer | 868 | 发送的评论数量(包括已删除评论和未通过聊天审核的评论等,但不包括图片评论)以及参与抽奖、红包等互动活动时发送的弹幕口令数。 |
LotteryAwards | Array of String | ["实物抽奖"] | 在实时抽奖中获得的奖品名称列表。 |
PayAmount | String | 2 | 付费金额。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
WatchCount | Integer | 6 | 观众累计观看的直播间数量。 |
WatchDuration | Integer | 170843 | 观众访问观看页的累计页面访问时长。单位为秒。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
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 | 观众触发无互动检测提醒弹窗的次数。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
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": "2023111617074678759421293A7E231A06", "Action": "GetAccountUserTrackData", "Version": "2023-08-01", "Service": "livesaas", "Region": "cn-north-1", "SystemTime": 1700125666 }, "Result": { "UserTrackData": { "UserTracks": [ { "ActivityId": 178452648, "ActivityName": "直播间 A", "JoinTime": 1681800648, "WatchDurationLive": 600, "WatchDurationReplay": 300, "CommentCount": 868, "LotteryAwards": ["实物抽奖"], "PayAmount": "2" } ], "UserTrackSum": { "WatchCount": 6, "WatchDuration": 170843 }, "InteractData": { "ReservationCount": 1, "VoteCount": 2, "CommentCount": 89, "QuestionnaireCount": 7, "LotteryCount": 1, "LotteryHitCount": 1, "InviteCount": 1, "ShiftScreenNumber": 1, "MuteNumber": 0, "NoInteractNumber": 1 }, "PayData": { "TotalAmount": "2", "PayCount": 1 } }, "FilterUserTrack": { "UserTracks": [ { "ActivityId": 178452648, "ActivityName": "直播间 A", "JoinTime": 1681822654, "WatchDurationLive": 600, "WatchDurationReplay": 300, "CommentCount": 86, "LotteryAwards": ["实物抽奖"], "PayAmount": "2" } ], "UserTrackSum": { "WatchCount": 6, "WatchDuration": 170843 }, "InteractData": { "ReservationCount": 1, "VoteCount": 2, "CommentCount": 89, "QuestionnaireCount": 7, "LotteryCount": 1, "LotteryHitCount": 1, "InviteCount": 1, "ShiftScreenNumber": 1, "MuteNumber": 0, "NoInteractNumber": 1 }, "PayData": { "TotalAmount": "2", "PayCount": 1 } } } }
下表提供了该接口特有的错误码,公共错误码请参见公共错误码和错误码文档。
状态码 | 错误码 | 错误信息 | 说明 |
---|---|---|---|
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. | 数据搜索服务出现内部错误。请重试。 |