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=ListAccountUserData&Version=2023-08-01

请求参数

Query

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

Body

参数类型是否必选示例值描述

PageToken

String

init

滚动查询 ID。滚动查询方式适用于查询 10,000 条以上数据的场景。
使用滚动查询方式时,首次调用接口查询数据时将该参数值设置为 init,第二次调用接口查询时将该参数值设置为首次查询返回参数中 PageToken 的值,第三次调用接口查询时将该参数值设置为第二次查询返回参数中 PageToken 的值,依次类推。当查询到最后分页,没有更多数据时,返回 finish

说明

返回参数中 PageToken 值的失效时间为 3 分钟,即超过 3 分钟该 PageToken 值会失效,无法使用该值进行下一次查询。

PageSizeInteger20分页查询数量,取值范围为 [1,1000],默认取值为 20

SortField

String

CommentCount

排序维度。默认按照用户 ID 进行排序。

  • CommentCount:观众发送的评论数量
  • WatchTime:累计观看时长/累计页面访问时长
  • LiveCount:观众累计观看的直播间数量

SortMode

String

desc

排序模式。默认取值为 desc

  • asc:升序
  • desc:降序
KeyWordString昵称根据观众昵称或手机号进行筛选。观众昵称支持模糊搜索。最多支持输入 1,000 个字符。
ActivityIdLong177***4894直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。

PlayStatus

String

All

根据以下维度进行筛选。默认取值为 All

  • All:观看直播、预告、回放的数据。
  • Live:观看直播的数据。
  • Preview:观看预告的数据。
  • Replay:观看回放的数据。
  • PageView:访问观看页的数据。
SelectTagsArray of SelectTags-根据分类标签信息进行筛选。您可以通过 ListSiteTagAPIV2 接口查询标签信息。

PageNumber

Float

1

分页查询页码,默认取值为 1

  • 使用滚动查询时,不需要传入该参数。
  • 未使用滚动查询时,接口最多支持返回 10,000 条查询结果,即 PageNumber×PageSize≤10,000。

SelectTags

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

返回参数

参数类型示例值描述
PageTokenStringfinish滚动查询 ID。
PageSizeInteger20分页查询数量。
TotalCountInteger1用户画像总数量。
UsersArray of Users-观众的用户画像数据。
PageNumberInteger1分页查询页码。

Users

参数类型示例值描述
BasicDataObject of BasicData-基础数据。
InteractDataObject of InteractData-互动数据。
PayDataObject of PayData-付费数据。
UserEnterFormObject of UserEnterForm-直播报名数据。
WatchDataObject of WatchData-观看和页面访问数据。

BasicData

参数类型示例值描述
UserIdLong1768842653观众在企业直播的唯一标识。
NickNameString昵称观众昵称。
TelephoneString154***4892观众登录直播间的手机号。
IPString36.110.167.68观众的 IP 地址。
CountryString中国观众所在国家。
ProvinceString北京观众所在省份。
WatchTypeString手机号该参数与观众登录直播间的方式有关。例如,观众通过手机号登录直播间则返回手机号,通过登录您的自有账号系统进入直播间则此处返回登录账号的 App 名称。
WatchDeviceStringAndroid 6.0观众进入直播间使用的终端机型。
ExternalIdString127***1145观众在第三方平台的唯一标识。您可以根据该关联用户 ID 识别企业自身的用户身份,以便于按需实现用户洞察和进行数据分析。观众通过不同方式登录直播间时,关联用户 ID 取值不同,具体取值情况详见数据统计

InteractData

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

PayData

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

UserEnterForm

参数类型示例值描述
EnterReviewNameString报名姓名直播报名填写的姓名。
EnterReviewSexString报名性别直播报名填写的性别。
EnterReviewAgeString报名年龄直播报名填写的年龄。
EnterReviewBirthdayString报名生日直播报名填写的生日。
EnterReviewTelString185***4856直播报名填写的手机号。
EnterReviewEmailStringzhibo@xxx.com直播报名填写的邮箱。
EnterReviewCompanyString报名公司直播报名填写的公司名称。
EnterReviewIndustryString报名行业直播报名填写的行业名称。
EnterReviewPositionString报名职位直播报名填写的职位。
EnterReviewEducationString报名学历直播报名填写的学历。

WatchData

参数类型示例值描述
LiveCountLong3观众累计观看的直播间数量。
WatchTimeLong500观众观看超低延时直播、普通延时直播、预告、回放的累计观看时长。单位为秒。
RtmLiveDataLong200观众观看超低延时直播的累计时长。单位为秒。
WatchLiveDurationLong300观众观看超低延时直播、普通延时直播的累计观看时长。单位为秒。
WatchPreviewDurationLong100观众观看预告的累计观看时长。单位为秒。
WatchReplayDurationLong100观众观看回放的累计观看时长。单位为秒。
WatchPageDurationLong200观众访问观看页的累计页面访问时长。单位为秒。

示例

请求示例

POST https://livesaas.volcengineapi.com/?Action=ListAccountUserData&Version=2023-08-01

{
  "PageNumber": 1,
  "PageSize": 20,
  "SortField": "CommentCount",
  "SortMode": "desc",
  "PlayStatus": "All"
}

返回示例

{
   "ResponseMetadata": {
        "RequestId": "202311161801062C9760A8DC24AC24A159",
        "Action": "ListAccountUserData",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1700128867
    },
    "Result": {
        "PageToken": "finish",
        "PageSize": 4000,
        "PageNumber": 0,
        "TotalCount": 20343,
        "Users": [
            {
                "BasicData": {
                    "UserId": 1768842653,
                    "NickName": "昵称",
                    "Telephone": "154***4892",
                    "IP": "36.110.167.68",
                    "Country": "中国",
                    "Province": "北京",
                    "WatchType": "手机号",
                    "WatchDevice": "Android 6.0",
                    "ExternalId": "127***1145"
                },
                "InteractData": {
                    "ReservationCount": 1,
                    "VoteCount": 1,
                    "CommentCount": 2,
                    "QuestionnaireCount": 2,
                    "LotteryCount": 5,
                    "LotteryHitCount": 3,
                    "InviteCount": 5,
                    "ShiftScreenNumber": 2,
                    "MuteNumber": 1,
                    "NoInteractNumber": 1
                },
                "WatchData": {
                    "LiveCount": 3,
                    "WatchTime": 500,
                    "RtmLiveData": 200,
                    "WatchLiveDuration": 300,
                    "WatchPreviewDuration": 100,
                    "WatchReplayDuration": 100,
                    "WatchPageDuration": 200
                },
                "PayData": {
                    "TotalAmount": "5",
                    "PayCount": 1
                },
                "UserEnterForm": {
                    "EnterReviewName": "报名姓名",
                    "EnterReviewSex": "报名性别",
                    "EnterReviewAge": "报名年龄",
                    "EnterReviewBirthday": "报名生日",
                    "EnterReviewTel": "185***4856",
                    "EnterReviewEmail": "zhibo@xxx.com",
                    "EnterReviewCompany": "报名公司",
                    "EnterReviewIndustry": "报名行业",
                    "EnterReviewPosition": "报名职位",
                    "EnterReviewEducation": "报名学历"
                }
            }
        ]
    }
  
}

错误码

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

状态码错误码错误信息说明
400InvalidParameter.InvalidAccountIdThe specified parameter AccountId is invalid.当前账号的鉴权信息错误。
400InvalidParameter.InvalidSortFieldThe specified parameter SortField is invalid.SortField 参数不符合规范,请修改后重试。
400InvalidParameter.InvalidPlayStatusThe specified parameter PlayStatus is invalid.PlayStatus 参数不符合规范,请修改后重试。
400InvalidParameter.InvalidKeyWordThe specified parameter KeyWord is invalid.KeyWord 参数超过最大字符限制。请修改后重试。
400InvalidParameter.SearchSizeInvalidSearch scope is too large,please use PageToken search data more than 10,000.搜索数据超过 10,000 条,请使用 PageToken 进行滚动查询。
400InvalidParameter.PageTokenInvalidPageToken does not exist or expires. Please initialize the query againPageToken 参数值不存在或已过期。请使用 PageToken 重新进行滚动查询。
400InvalidParameter.PageTokenConditionModifyThe search condition change, PageToken cannot be used. Please initialize the query again.搜索条件变更,继续使用之前的 PageToken 返回值搜索会错误。请使用 PageToken 重新进行滚动查询。
500InternalErrorData search inner error, please try again.数据搜索服务出现内部错误。请重试。