最近更新时间:2023.11.08 09:30:20
首次发布时间:2023.02.01 10:13:34
分析用户行为时,您可能会需要查看用户观看时长的分布情况。AnalysisUserBehaviorPeopleV2
接口支持指定直播状态 PlayStatus
,获取观看时长超过百分比 Percentage
阈值的观众数量。获取直播间用户观看时长人数分布。
说明
企业直播新增渠道推广功能,支持创建不同的渠道。有关如何创建渠道,详见渠道推广。对于使用了渠道推广功能的直播间,请调用本接口获取不同渠道的数据信息。如果您未使用渠道推广功能,请调用 AnalysisUserBehaviorPeople 接口获取直播间不同观看时长的人数。
请求频率:单用户请求频率限制为 120 次/分钟。
以下请求参数列表仅列出了该接口的部分公共参数,完整公共参数列表见公共请求参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | AnalysisUserBehaviorPeopleV2 | 接口名称。当前 API 的名称为 AnalysisUserBehaviorPeopleV2 。 |
Version | String | 是 | 2020-06-01 | 接口版本。当前 API 的版本为 2020-06-01 。 |
ActivityId | Long | 是 | 1779168287 | 直播间 ID。您可以通过调用 ListActivityAPI 接口查询 ID。 |
PlayStatus | Integer | 是 |
| 根据直播状态进行筛选。支持以下取值。
|
StartTime | Long | 否 |
| 查询范围的开始时间,Unix 时间戳,单位为秒。 |
EndTime | Long | 否 |
| 查询范围的结束时间,Unix 时间戳,单位为秒。 |
TotalTime | Long | 否 |
| 总时长,作为观看时长占比
|
Percentage | Long | 是 |
| 观看时长占总时长的百分比,取值范围为 (0,100]。 |
Channel | String | 否 | 123 | 根据渠道标识进行筛选。您可以通过调用 ListChannelAPI 接口查询渠道标识 (ChannelTag ),默认查询全部渠道数据。 |
Extra | String | 否 | abc | 根据业务方扩展字段进行筛选。自定义登录时,用户行为中记录了 extra 值。 |
IsMerge | Integer | 否 |
| 是否根据设备(Cookie)筛选。 说明
|
IsMergeUserId | Integer | 否 |
| 是否根据 userID 筛选,没有 userID 的根据设备(Cookie)进行筛选。 说明
|
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
TotalPeople | Long | 123 | 总人数 |
TotalTime | Long | 1234 | 总时间 |
AnalysisPeople | Long | 12 | 实际观看时长占总时长的百分比大于等于Percentage 的人数。 |
GET https://livesaas.volcengineapi.com/?Action=AnalysisUserBehaviorPeopleV2&Version=2020-06-01&ActivityId=1779168287&Channel=123&EndTime=1654019002&Extra=abc&IsMerge=0&IsMergeUserId=1&Percentage=50&PlayStatus=1&StartTime=1652895802&TotalTime=600
{ "ResponseMetadata": { "RequestId": "202201201826170101501312091D1C09D2", "Action": "AnalysisUserBehaviorPeopleV2", "Version": "2020-06-01", "Service": "livesaas", "Region": "cn-north-1", "SystemTime": 1656067132 }, "Result": { "TotalPeople": 123, "TotalTime": 1234, "AnalysisPeople": 12 } }
访问公共错误码获取详细信息。