You need to enable JavaScript to run this app.
导航
AnalysisUserBehaviorPeopleV2 - 获取直播间不同观看时长的人数
最近更新时间:2025.03.24 16:50:55首次发布时间:2023.02.01 10:13:34
我的收藏
有用
有用
无用
无用

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

注意事项

  • 请求频率:单用户请求频率限制为 120 次/分钟
  • 前提条件:确保您拥有火山引擎主账号或具备直播间的数据统计 > 仅查看可编辑权限的子账号。有关如何添加子账号,详见子账号管理

请求说明

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

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数

Query

参数类型是否必选示例值描述
ActionStringAnalysisUserBehaviorPeopleV2接口名称。当前 API 的名称为 AnalysisUserBehaviorPeopleV2
VersionString2020-06-01接口版本。当前 API 的版本为 2020-06-01

ActivityId

Long

1779168287

直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。

说明

使用子账号调用接口时,确保该直播间对子账号可见。有关如何配置子账号的可见范围,详见子账号管理

PlayStatus

Integer

1

根据直播状态进行筛选。支持以下取值:

  • 1:直播
  • 2:预告
  • 3:回放
    例如,取值为 1,将统计直播状态下的用户数量。

StartTime

Long

1652895802

查询范围的开始时间,Unix 时间戳,单位为秒。
例如,取值为 1652895802,表示查询 2022-05-19 01:43:22 之后的观众数量。

EndTime

Long

1654019002

查询范围的结束时间,Unix 时间戳,单位为秒。
例如,取值为 1654019002,表示查询 2022-06-01 01:43:22 之前的观众数量。

TotalTime

Long

600

总时长,作为观看时长占比 Percentage 的分母,单位为秒。

  • 默认取值为 0,表示统计状态为 PlayStatus 的历史总时长。
  • 当推流时长与实际直播时长不一致时,建议设置该值,以提升结果准确性。
    例如,A 直播从 12:00 开始推流,14:00 结束推流;其中,前 30 分钟播放预告片,之后 90 分钟为直播时间,则可以将 TotalTime 设置为 5400。

Percentage

Long

50

观看时长占总时长的百分比,取值范围为 (0,100]。
例如,取值为 50,将查询实际观看时长 ≥ 50%×TotalTime 的观众数量。

ChannelString123根据渠道标识进行筛选。默认查询全部渠道数据。您可以通过 ListChannelAPI 接口查询渠道标识 (ChannelTag)。
ExtraStringabc根据业务方扩展字段进行筛选。自定义登录时,用户行为中记录了 extra 值。

IsMerge

Integer

0

是否根据设备(Cookie)筛选。

说明

IsMergeIsMergeUserId 参数,仅能传一个且取值必须为 1

  • 0:不根据设备(Cookie)筛选
  • 1:根据设备(Cookie)筛选

IsMergeUserId

Integer

1

是否根据 userID 筛选,没有 userID 的根据设备(Cookie)进行筛选。

说明

IsMergeIsMergeUserId 参数,仅能传一个且取值必须为 1

  • 0:不根据 userID 筛选
  • 1:根据 userID 筛选

返回参数

参数类型示例值描述
TotalPeopleLong123总人数。
TotalTimeLong1234总时长。
AnalysisPeopleLong12实际观看时长占总时长的百分比大于等于 Percentage 的人数。

请求示例

GET https://livesaas.volcengineapi.com/?Action=AnalysisUserBehaviorPeopleV2&Version=2020-06-01&ActivityId=1779168287&PlayStatus=1&StartTime=1652895802&EndTime=1654019002&TotalTime=600&Percentage=50&Channel=123&Extra=abc&IsMerge=0&IsMergeUserId=1

返回示例

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

错误码

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