获取直播间营销数据信息--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

获取直播间营销数据信息

最近更新时间：2024.09.04 17:25:19首次发布时间：2023.02.01 10:13:46

您可通过此接口获取指定直播间的营销数据。数据每 5 分钟更新一次。

注意事项

请求频率：单用户请求频率限制为 120 次/分钟。

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetAdvertisementDataAPIV2`	接口名称。当前 API 的名称为 `GetAdvertisementDataAPIV2`。
Version	String	是	`2020-06-01`	接口版本。当前 API 的版本为 `2020-06-01`。
ActivityId	Long	是	`1779168287`	直播间 ID。您可以通过调用 ListActivityAPI 接口查询 ID
Channel	String	否	`123`	根据渠道标识进行筛选。您可以通过调用 ListChannelAPI 接口查询渠道标识，默认查询全部渠道数据。

返回参数

参数	类型	示例值	描述
ActivityId	Long	`1779168287`	直播间 ID
AccountClicks	Object of AccountClicks	`-`	营销账号数据
AdvertisingClicks	Object of AdvertisingClicks	`-`	营销广告数据
AdInfo	Array of AdInfo	`-`	营销广告详细数据
ShowThumbUpNumber	Integer	`13`	虚拟点赞数
ActualThumbUpNumber	Integer	`5`	实际点赞数

AccountClicks

参数	类型	示例值	描述
PV	Integer	`111`	营销账号或营销广告的点击次数。
UV	Integer	`111`	营销账号或营销广告的点击人数。
TotalTime	Integer	`100`	已废弃

AdvertisingClicks

参数	类型	示例值	描述
PV	Integer	`111`	营销账号或营销广告的点击次数。
UV	Integer	`100`	营销账号或营销广告的点击人数。
TotalTime	Integer	`100`	已废弃

AdInfo

参数	类型	示例值	描述
PageAdvertiseType	Integer	`4`	广告类型。支持以下四种取值。 1：页头广告 2：页中广告 3：浮标广告 4：商品卡片广告
Content	String	`企业直播`	广告内容
Link	String	`www.example.com`	广告链接
Title	String	`商品 1`	广告标题
PV	Integer	`111`	营销广告的点击次数。
UV	Integer	`100`	营销广告的点击人数。

示例

请求示例

GET https://livesaas.volcengineapi.com/?Action=GetAdvertisementDataAPIV2&Version=2020-06-01&ActivityId=1779168287&Channel=123

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202201201826170101501312091D1C09D2",
    "Action": "GetAdvertisementDataAPIV2",
    "Version": "2020-06-01",
    "Service": "livesaas",
    "Region": "cn-north-1",
    "SystemTime": 1656067132
  },
  "Result": {
    "ActivityId": 1779168287,
    "AccountClicks": {
      "PV": 111,
      "UV": 111,
      "TotalTime": 100
    },
    "AdvertisingClicks": {
      "PV": 111,
      "UV": 100,
      "TotalTime": 100
    },
    "AdInfo": [
      {
        "PageAdvertiseType": 4,
        "Content": "企业直播",
        "Link": "www.example.com",
        "PV": 111,
        "UV": 100,
        "Title": "商品 1"
      }
    ],
    "ShowThumbUpNumber": 13,
    "ActualThumbUpNumber": 5
  }
}

错误码

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