You need to enable JavaScript to run this app.
导航
GetActivityLivePromotionData - 获取直播间直播转推数据
最近更新时间:2025.03.24 16:50:57首次发布时间:2024.04.02 13:37:23
我的收藏
有用
有用
无用
无用

调用 GetActivityLivePromotionData 接口,获取指定直播间的直播次数、转推场次及直播转推时长等转推数据。

注意事项

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

请求说明

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

请求参数

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

Query

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

ActivityId

Long

17927****17616

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

说明

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

StartTime

Long

1692339016

查询起始时间。Unix 时间戳,单位为秒。默认取值为当前时间 - 30 天(即 2,592,000 秒)。默认查询近 30 天的转推数据。

说明

当不传 EndTimeEndTime 取值为 0 时,StartTime 会使用默认值。

EndTime

Long

1700115016

查询结束时间。Unix 时间戳,单位为秒。默认取值为当前时间。默认查询近 30 天的转推数据。

说明

当不传 EndTimeEndTime 取值为 0 时,EndTime 会使用默认值。

返回参数

参数类型示例值描述
LiveCountLong12直播场次,即直播间直播的次数。直播间的 1 次开关播,算作 1 个直播场次。单位为次。
LivePromotionCountLong12转推场次,即直播间开启直播转推开关的直播场次数。一场直播中,无论转推到多少个第三方平台或账号、转推是否成功,转推场次均算作 1。单位为次。有关如何开启直播转推开关,详见直播转推
LivePromotionDurationLong3071转推时长,即直播间开启直播转推开关的直播场次的直播时长之和。单位为秒。有关如何开启直播转推开关,详见直播转推。1 个直播场次只要转推过,就以该场次完整直播时长计算。例如直播间 A 开启过 2 场直播且均开启了直播转推开关。其中第一场直播的时长为 3600 秒,转推 B 平台 1200 秒,转推 C 平台 3000 秒,则第一场直播的转推时长为 3600 秒。第二场直播的时长为 1800 秒,转推 D 平台 300 秒,则第二场直播的转推时长为 1800 秒。因此,直播间 A 的转推时长为 5400(36000+1800) 秒。
LivePromotionPlatformCountLong21转推平台数量,即直播间所有直播场次成功转推的平台数之和。单位为个。有关如何开启直播转推开关,详见直播转推
AppLiveTemplateLiveCountLong2手机开播装修场次,即直播间使用 VolcLive 应用或 Android/iOS 开播 SDK 的挂件或图层(包括直播模板中的挂件和图层)功能进行装修的直播场次数。单位为次。有关如何使用挂件和图层功能,详见手机开播SDK 概览
AppLiveTemplateLiveDurationLong430手机开播装修时长,即直播间使用 VolcLive 应用或 Android/iOS 开播 SDK 的挂件或图层(包括直播模板中的挂件和图层)功能进行装修的直播场次的直播时长之和。单位为秒。有关如何使用挂件和图层功能,详见手机开播SDK 概览

请求示例

GET https://livesaas.volcengineapi.com/?Action=GetActivityLivePromotionData&Version=2023-08-01&ActivityId=17927****17616&StartTime=1692339016&EndTime=1700115016

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "GetActivityLivePromotionData",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1697446406
    },
    "Result": {
        "LiveCount": 12,
        "LivePromotionCount": 12,
        "LivePromotionDuration": 3071,
        "LivePromotionPlatformCount": 21,
        "AppLiveTemplateLiveCount": 2,
        "AppLiveTemplateLiveDuration": 430
    }
}

错误码

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

状态码错误码错误信息说明
400InvalidParameter.InvalidTimeRangeThe specified time range is invalid.查询时间范围错误。请修改后重试。