文档中心

获取直播间不同观看时长的人数

最近更新时间：2023.04.19 15:23:31

首次发布时间：2022.05.25 14:48:15

分析用户行为时，您可能会需要查看用户观看时长的分布情况。AnalysisUserBehaviorPeople 接口支持指定直播状态 PlayStatus，获取观看时长超过百分比 Percentage 阈值的观众数量。获取直播间用户观看时长人数分布。

说明

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

请求说明

接口名称：AnalysisUserBehaviorPeople
请求方式：GET
接口地址：http://livesaas.volcengineapi.com/?Action=AnalysisUserBehaviorPeople&Version=2020-06-01
请求频率：单用户请求频率限制为 120 次/分钟。

请求参数

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

Query

参数	类型	是否必选	描述
Action	String	是	接口名称
Version	String	是	接口版本。直播当前 API 的版本为 2020-06-01。
ActivityID	Int64	是	直播间 ID
PlayStatus	Int32	是	根据直播状态进行筛选。支持以下取值。 1：直播； 2：预告； 3：回放。例如，取值为 `1`，将统计直播状态下的用户数量。
StartTime	Int64	否	查询范围的开始时间，Unix 时间戳，单位为秒。例如，取值为 `1652895802`，表示查询 `2022-05-19 01:43:22` 之后的观众数量。
EndTime	Int64	否	查询范围的结束时间，Unix 时间戳，单位为秒。例如，取值为 `1654019002`，表示查询 `2022-06-01 01:43:22` 之前的观众数量。
TotalTime	Int64	否	总时长，作为观看时长占比 `Percentage` 的分母，单位为秒。默认取值为 `0`，表示统计状态为 `PlayStatus` 的历史总时长。当推流时长与实际直播时长不一致时，建议设置该值，以提升结果准确性。例如，A 直播从 12:00 开始推流，14:00 结束推流；其中，前 30 分钟播放预告片，之后 90 分钟为直播时间，则可以将 `TotalTime` 设置为 5400。
Percentage	Int64	是	观看时长占总时长的百分比，取值范围为 (0,100]。例如，取值为 50，将查询实际观看时长 ≥ 50%×`TotalTime` 的观众数量。
Source	Int32	否	根据页面访问来源进行筛选。支持以下六种取值，默认取值为 `0`。 -1：全部地址； 0：默认地址； 1：地址 A； 2：地址 B； 3：地址 C； 4：地址 D。
Extra	String	否	业务方扩展字段，可根据该字段进行筛选。自定义登录时，用户行为中记录了 `extra` 值。
IsMerge	Int32	否	是否根据设备（Cookie）筛选。说明 `IsMerge` 和 `IsMergeUserId` 参数，仅能传一个且取值必须为 `1`。 0：不根据设备（Cookie）筛选； 1：根据设备（Cookie）筛选。
IsMergeUserId	Int32	否	是否根据 userID 筛选，没有 userID 的根据设备（Cookie）进行筛选。说明 `IsMerge` 和 `IsMergeUserId` 参数，仅能传一个且取值必须为 `1`。 0：不根据 userID 筛选； 1：根据 userID 筛选。

返回参数

参数	类型	描述
TotalPeople	Int64	总人数
TotalTime	Int64	总时间
AnalysisPeople	Int64	实际观看时长占总时长的百分比大于等于`Percentage` 的人数。

示例

请求示例

Get http://livesaas.volcengineapi.com/?Action=AnalysisUserBehaviorPeople&Version=2020-06-01&ActivityID=1231231231&PlayStatus=1&StartTime=1652895802&EndTime=1652895802&Percentage=50&TotalTime=5400&Source=-1&IsMerge=1

正常返回示例

{
		"ResponseMetadata":{
				"RequestId":"202201201826170101501312091D1C09D2",
				"Action":"AnalysisUserBehaviorPeople",
				"Version":"2020-06-01",
				"Service":"livesaas",
				"Region":"cn-north-1",
				"SystemTime":1656067132
		},
		"Result":{
				"TotalPeople": 123,
				"TotalTime": 1234,
				"AnalysisPeople": 12
		}
}

异常返回示例

{
		"ResponseMetadata":{
				"RequestId"	:"202201201826170101501312091D1C09D2",
				"Action":"AnalysisUserBehaviorPeople",
				"Version":"2020-06-01",
				"Service":"livesaas",
				"Region":"cn-north-1",
				"SystemTime":1656067132,
		},
		"Error":{
				"Code":"200000",
				"Message":"参数异常"	
		}	
}

错误码

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