您可通过此接口获取指定直播间的观众行为数据。
请求频率：单用户请求频率限制为 120 次/分钟。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | ListUserBehaviorDataAPIV2 | 接口名称。当前 API 的名称为 ListUserBehaviorDataAPIV2。 |
| Version | String | 是 | 2020-06-01 | 接口版本。当前 API 的版本为 2020-06-01。 |
| ActivityId | Long | 是 | 177228678085 | 直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。 |
PageNo | Integer | 否 |
| 分页查询页码，默认值为
|
| PageItemCount | Integer | 否 | 10 | 分页查询数量，取值范围为 [1,500]，默认值为 10。 |
ScrollId | String | 否 |
| 滚动查询 ID。滚动查询方式适用于查询 10,000 条以上数据的场景。如需使用滚动查询方式，确保满足以下要求：
|
| Name | String | 否 | A | 根据观众昵称进行模糊查询。 |
| StartTime | Long | 否 | 1642070520 | 查询开始时间，Unix 时间戳，单位为秒。 |
| EndTime | Long | 否 | 1642070920 | 查询结束时间，Unix 时间戳，单位为秒。 |
IsMerge | Integer | 否 |
| 当同一个设备多次进出直播间时，是否合并为 1 次。默认值为
|
| Channel | String | 否 | 1 | 根据渠道标识进行筛选。您可以通过 ListChannelAPI 接口查询渠道标识，默认查询全部渠道数据。 |
PlayStatus | Integer | 否 |
| 根据直播状态进行筛选。默认值为
|
IsMergeUserId | Integer | 否 |
| 当同一个观众多次进出直播间时，是否合并为 1 次。默认值为
|
| Extra | String | 否 | qwe | 根据业务方扩展参数进行筛选。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| TotalItemCount | Integer | 1 | 观众总数。 |
| Data | Array of UserBehaviorData | - | 观众行为详细数据。 |
| ScrollId | String | bcd | 滚动查询 ID。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
UserId | Long |
| 用户 ID，即观众在企业直播的唯一标识。 说明 如果观众未通过输入昵称或其他方式登录直播间，其用户 ID 显示为 0。 |
| UserName | String | 观众 A | 观众昵称。 |
| Region | String | 美国 | 观众的所属地域。 |
| IP | String | 127.0.0.1 | 观众的IP 地址，若是合并时，多个 IP 用空格分隔。 |
| JoinAt | Array of Integer | 1642070550 | 观众进入直播间的时间，与 LeaveAt 一一对应。Unix 时间戳，单位为秒。 |
| LeaveAt | Array of Integer | 1642070590 | 观众离开直播间的时间，与 JoinAt 一一对应。Unix 时间戳，单位为秒。 |
| WatchTime | Integer | 40 | 观众访问观看页的时长或者使用播放器观看的时长。单位为分钟。 |
| UserTel | String | 151xxx | 观众用于登录直播间的手机号。 |
| InviteCode | String | 2188 | 观众进入直播间的邀请码。 |
AccessTime | String |
| 观众进入直播间的时机。支持以下取值：
|
| UserDevice | Array of String | CPU iPhone OS 10_3_1 like Mac OS X | 观众进入直播间使用的终端机型。 |
| Extra | String | qwe | 业务方扩展参数。 |
| ExternalUserId | String | 1efcsds*** | 观众在第三方平台的唯一标识。您可以根据该关联用户 ID 识别企业自身的用户身份，以便于按需实现用户洞察和进行数据分析。观众通过不同方式登录直播间时，关联用户 ID 取值不同，具体取值情况详见数据统计。 |
SilenceStatus | Integer |
| 查询时观众是否被禁言。支持以下取值：
|
| ChannelName | String | 主渠道 | 观众最初进入直播间时所在的推广渠道名称。 |
| CommentCounts | Integer | 3 | 观众发送的聊天数量（包括已删除评论和未通过聊天审核的评论等，但不包括图片评论）。 |
| ShiftScreenNumber | Integer | 1 | 观众触发切屏检测提醒弹窗的次数。 |
| MuteNumber | Integer | 1 | 观众触发静音停播提醒弹窗的次数。 |
| NoInteractNumber | Integer | 1 | 观众触发无互动检测提醒弹窗的次数。 |
| UserCredit | Integer | 1 | 观众收到表扬点赞的次数。 |
| Os | String | mac | 观众进入直播间使用的操作系统。 |
InviterName | String |
| 分享人的昵称。 说明 仅在观众是通过其他观众分享的专属链接、二维码或海报进入并登录的当前直播间时，该参数有值。 |
InviterId | Float |
| 分享人的用户 ID。 说明 仅在观众是通过其他观众分享的专属链接、二维码或海报进入并登录的当前直播间时，该参数有值。 |
| CheckInNumber | Integer | 10 | 观众签到的次数。 |
EmployeeNo | String |
| 观众的工号。 说明 该参数仅在以下条件均满足后有值：
|
GET https://livesaas.volcengineapi.com/?Action=ListUserBehaviorDataAPIV2&Version=2020-06-01&ActivityId=177228678085&PageNo=1&PageItemCount=10&ScrollId=abc&Name=123&StartTime=1642070520&EndTime=1642070920&IsMerge=0&Channel=1&PlayStatus=10&IsMergeUserId=0&Extra=qwe
{ "ResponseMetadata": { "RequestId": "20230604110420****100232280022D31", "Action": "ListUserBehaviorDataAPIV2", "Version": "2020-06-01", "Service": "livesaas", "Region": "cn-north-1", "SystemTime": 1721111109 }, "Result": { "TotalItemCount": 1, "Data": [ { "UserId": 11, "UserName": "观众 A", "Region": "美国", "IP": "127.0.0.1", "JoinAt": [ 1642070550 ], "LeaveAt": [ 1642070590 ], "WatchTime": 40, "UserTel": "151xxx", "InviteCode": "2188", "AccessTime": "playing", "UserDevice": [ "CPU iPhone OS 10_3_1 like Mac OS X" ], "Extra": "qwe", "ExternalUserId": "1efcsds***", "SilenceStatus": 1, "ChannelName": "主渠道", "CommentCounts": 3, "MuteNumber": 1, "NoInteractNumber": 1, "ShiftScreenNumber": 1, "UserCredit": 1, "Os": "mac", "InviterName": "观众 B", "InviterId": 12312412, "CheckInNumber": 10, "EmployeeNo": "123" } ], "ScrollId": "bcd" } }