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

获取主账号下的用户画像详情

最近更新时间：2023.11.23 14:40:38

首次发布时间：2023.11.23 14:40:38

我的收藏

获取主账号下的所有观众的用户画像详情。

注意事项

请求频率：单用户请求频率限制为 1 次/秒。

请求说明

  • 请求方式：POST
  • 请求地址：https://livesaas.volcengineapi.com/?Action=GetAccountUserTrackData&Version=2023-08-01

请求参数

Query

参数类型是否必选示例值描述
ActionString是GetAccountUserTrackData接口名称。当前 API 的名称为 GetAccountUserTrackData。
VersionString是2023-08-01接口版本。当前 API 的版本为 2023-08-01。

Body

参数类型是否必选示例值描述
UserIdLong是1***9观众在企业直播的唯一标识。您可以通过 ListAccountUserData 接口查询 ID。
ActivityIdLong否178***48直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。
SelectTagsArray of SelectTags否-根据分类标签信息进行筛选。您可以通过 ListSiteTagAPIV2 接口查询标签信息。

SelectTags

参数类型是否必选示例值描述
IndexInteger否0标签的索引值。用于标识标签在控制台展示的位置。取值范围为 [0,19]。
ValueArray of String是["标签值"]分类标签值。每个标签值最多为 20 个字符。
NameString否标签名称分类标签名称。最多支持输入 8 个字符。

返回参数

参数类型示例值描述
UserTrackDataObject of UserTrackData-完整的观众用户画像详情。

FilterUserTrack

Object of FilterUserTrack

-

筛选后的观众用户画像详情。

说明

通过 ActivityId 或 SelectTags 进行筛选时，该参数返回筛选后的观众用户画像详情，否则该参数为空。

UserTrackData

参数类型示例值描述
UserTracksArray of UserTracks-观看足迹。
UserTrackSumObject of UserTrackSum-累计观看数据。
InteractDataObject of InteractData-互动数据。
PayDataObject of PayData-付费数据。

FilterUserTrack

参数类型示例值描述
UserTracksArray of UserTracks-观看足迹。
UserTrackSumObject of UserTrackSum-累计观看数据。
InteractDataObject of InteractData-互动数据。
PayDataObject of PayData-付费数据。

UserTracks

参数类型示例值描述
ActivityIdLong178***48直播间 ID。
ActivityNameString直播间 A直播间名称。
JoinTimeLong1681800648进入直播间的时间。Unix 时间戳，单位为秒。
WatchDurationLiveInteger600观看直播的时长。单位为秒。
WatchDurationReplayInteger300观看回放的时长。单位为秒。
CommentCountInteger868发送的评论数量（包括已删除评论和未通过聊天审核的评论等，但不包括图片评论）以及参与抽奖、红包等互动活动时发送的弹幕口令数。
LotteryAwardsArray of String["实物抽奖"]在实时抽奖中获得的奖品名称列表。
PayAmountString2付费金额。

UserTrackSum

参数类型示例值描述
WatchCountInteger6观众累计观看的直播间数量。
WatchDurationInteger170843观众访问观看页的累计页面访问时长。单位为秒。

InteractData

参数类型示例值描述
ReservationCountInteger1观众预约直播的次数。
VoteCountInteger2观众参与投票的次数。
CommentCountInteger89观众发送的评论数量（包括已删除评论和未通过聊天审核的评论等，但不包括图片评论）以及参与抽奖、红包等互动活动时发送的弹幕口令数。
QuestionnaireCountInteger7观众填写问卷的次数。
LotteryCountInteger1观众参与实时抽奖的次数。
LotteryHitCountInteger1观众中奖的次数。
InviteCountInteger1观众分享直播的次数，即有多少用户通过观众分享的专属链接、二维码或海报进入并登录直播间。
ShiftScreenNumberInteger1观众触发切屏检测提醒弹窗的次数。
MuteNumberInteger0观众触发静音停播提醒弹窗的次数。
NoInteractNumberInteger1观众触发无互动检测提醒弹窗的次数。

PayData

参数类型示例值描述
TotalAmountString2付费金额。
PayCountInteger1付费观看次数。

示例

请求示例

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
            }
        }
    }
}

错误码

下表提供了该接口特有的错误码，公共错误码请参见公共错误码和错误码文档。

状态码错误码错误信息说明
400InvalidParameter.InvalidAccountIdThe specified parameter AccountId is invalid.当前账号的鉴权信息错误。
400InvalidParameter.InvalidUserIdThe specified parameter UserId is invalid.UserId 参数不符合规范，请修改后重试。
500InternalErrorData search inner error, please try again.数据搜索服务出现内部错误。请重试。