You need to enable JavaScript to run this app.
导航
企业直播
  • 文档首页
    • /
  • 企业直播

获取观众行为数据信息

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

首次发布时间：2023.02.01 10:14:16

我的收藏

获取当前直播间的观众行为数据。

说明

企业直播新增渠道推广功能，支持创建不同的渠道。有关如何创建渠道，详见渠道推广。对于使用了渠道推广功能的直播间，请调用本接口获取不同渠道的数据信息。如果您未使用渠道推广功能，请调用 ListUserBehaviorDataAPI 接口获取观众行为数据信息。

注意事项

请求频率：单用户请求频率限制为 120 次/分钟。

请求说明

  • 请求方式：GET
  • 请求地址：https://livesaas.volcengineapi.com/?Action=ListUserBehaviorDataAPIV2&Version=2020-06-01

请求参数

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

Query

参数类型是否必选示例值描述
ActionString是ListUserBehaviorDataAPIV2接口名称。当前 API 的名称为 ListUserBehaviorDataAPIV2。
VersionString是2020-06-01接口版本。当前 API 的版本为 2020-06-01。
ActivityIdLong是177228678085直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。

PageNo

Integer

否

1

分页查询页码，默认取值为 1。

  • 使用滚动查询时，PageNo 取值范围为 [1,2^64]。有关滚动查询，详见请求参数 ScrollId。
  • 未使用滚动查询时，接口最多支持返回 10,000 条查询结果，即 PageNo × PageItemCount ≤ 10,000。
PageItemCountInteger否10分页查询数量，取值范围为 [1,500]，默认取值为 10。

ScrollId

String

否

abc

滚动查询 ID。滚动查询方式适用于查询 10,000 条以上数据的场景。如需使用滚动查询方式，确保满足以下要求：

  • 首次调用接口查询数据时无需设置该参数值（即参数值为空），第二次调用接口查询时将该参数值设置为首次查询返回参数中 ScrollId 的值，第三次调用接口查询时将该参数值设置为第二次查询返回参数中 ScrollId 的值，依次类推。

    说明

    • 当 IsMerge 或 IsMergeUserId 取值为 1 时，若调用接口进行滚动查询，则 ScrollId 取值固定为空。
    • 返回参数中 ScrollId 值的失效时间为 20 分钟，即超过 20 分钟该 ScrollId 值会失效，无法使用该值进行下一次查询。
  • 首次调用接口查询数据时将 PageNo 的值设置为 1，第二次调用接口查询时将 PageNo 的值设置为 2，依次类推。

    说明

    PageNo 的值只能按照顺序依次递增且不支持输入重复的数值。

  • 在调用接口查询数据时，除 ScrollId 和 PageNo 参数外，确保 IsMerge 和 IsMergeUserId 参数的值保持不变。
NameString否123根据用户昵称进行模糊查询。
StartTimeLong否1642070520查询开始时间，Unix 时间戳，单位为秒。
EndTimeLong否1642070920查询结束时间，Unix 时间戳，单位为秒。

IsMerge

Integer

否

0

当同一个设备多次进出直播间时，是否合并为 1 次。支持以下取值，默认取值为 0。

  • 0：不合并
  • 1：合并
ChannelString否1根据渠道标识进行筛选。您可以通过 ListChannelAPI 接口查询渠道标识，默认查询全部渠道数据。

PlayStatus

Integer

否

10

根据直播状态进行筛选。支持以下取值，默认取值为 10。

  • 1：直播状态观看，包括超低延时直播和普通延时直播
  • 2：预告状态观看
  • 3：回放状态观看
  • 10：页面停留
  • 11：所有状态总观看
  • 12：普通延时直播观看
  • 13：超低延时直播观看

IsMergeUserId

Integer

否

0

当同一个用户多次进出直播间时，是否合并为 1 次。支持以下取值，默认取值为 0。

  • 0：不合并
  • 1：合并
ExtraString否qwe根据业务方扩展参数进行筛选。

返回参数

参数类型示例值描述
TotalItemCountInteger1观众总数。
DataArray of UserBehaviorData无观众行为详细数据。
ScrollIdStringbcd滚动查询 ID。

UserBehaviorData

参数类型示例值描述

UserId

Long

11

用户 ID，即观众在企业直播的唯一标识。

说明

如果观众未通过输入昵称或其他方式登录直播间，其用户 ID 显示为 0。

UserNameStringname用户昵称。
RegionString美国观众的所属地域。
IPString127.0.0.1观众的IP 地址，若是合并时，多个 IP 用空格分隔。
JoinAtArray of Integer1642070550用户进入直播间的时间，与 LeaveAt 一一对应。
LeaveAtArray of Integer1642070590用户离开直播间的时间，与 JoinAt 一一对应。
WatchTimeInteger40观众访问观看页的时长或者使用播放器观看的时长。单位为分。
UserTelString151xxx观众用于登录直播间的手机号。
InviteCodeString2188观众进入直播间的邀请码。

AccessTime

String

playing

观众进入直播间的时机。支持以下取值：

  • playing：直播中
  • playing before：直播前
  • playing post：直播后
UserDeviceArray of StringCPU iPhone OS 10_3_1 like Mac OS X观众进入直播间使用的终端机型。
ExtraStringqwe业务方扩展参数。
ExternalUserIdString1efcsds***观众在第三方平台的唯一标识。您可以根据该关联用户 ID 识别企业自身的用户身份，以便于按需实现用户洞察和进行数据分析。观众通过不同方式登录直播间时，关联用户 ID 取值不同，具体取值情况详见数据统计。

SilenceStatus

Integer

1

查询时观众是否被禁言。支持以下取值：

  • 1：已禁言
  • 其它值：未禁言
ChannelNameString主渠道观众最初进入直播间时所在的推广渠道名称。
CommentCountsInteger3观众发送的聊天数量（包括已删除评论和未通过聊天审核的评论等，但不包括图片评论）。
ShiftScreenNumberInteger1观众触发切屏检测提醒弹窗的次数。
MuteNumberInteger1观众触发静音停播提醒弹窗的次数。
NoInteractNumberInteger1观众触发无互动检测提醒弹窗的次数。
UserCreditInteger1观众收到表扬点赞的次数。

示例

请求示例

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": "2022012018261701***",
    "Action": "ListUserBehaviorDataAPIV2",
    "Version": "2020-06-01",
    "Service": "livesaas",
    "Region": "cn-north-1",
    "SystemTime": 1656067132
  },
  "Result": {
    "TotalItemCount": 1,
    "ScrollId": "abc",
    "Data": [
      {
        "UserId": 11,
        "UserName": "name",
        "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",
        "ExtraUserId":"1efcsds***",
        "SilenceStatus": 1,
        "ChannelName": "主渠道",
        "CommentCounts": 3,
        "ShiftScreenNumber": 1,
        "MuteNumber": 1,
        "NoInteractNumber": 1,
        "UserCredit":1
      }
    ]
  }
}

错误码

访问公共错误码和错误码获取详细信息。