导出直播间数据--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

导出直播间数据

最近更新时间：2024.11.27 10:46:11首次发布时间：2024.11.27 10:46:11

调用 ExportActivityData 接口，导出直播间的数据。目前仅支持导出直播间的人次、人数、人数峰值等页面访问和播放器观看的基础数据。

注意事项

请求频率：单用户请求频率限制为 10 次/秒。

请求说明

请求方式：POST
请求地址：https://livesaas.volcengineapi.com/?Action=ExportActivityData&Version=2023-08-01

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`ExportActivityData`	接口名称。当前 API 的名称为 `ExportActivityData`。
Version	String	是	`2023-08-01`	接口版本。当前 API 的版本为 `2023-08-01`。

Body

参数类型是否必选示例值描述

ActivityId Long 是 1856****1234 直播间 ID。您可通过调用 ListActivityAPI 接口获取 ID。

参数	类型	是否必选	示例值	描述
ActivityId	Long	是	`1856****1234`	直播间 ID。您可通过调用 ListActivityAPI 接口获取 ID。
DataType	Integer	是	`1`	直播间数据类型。目前仅支持取值 `1`，即直播间的以下基础数据。页面访问数据：访问人次、访问人数、访问人数峰值、累计访问时长、人均访问时长、人均访问次数播放器观看数据：预告、直播、回放和总观看的观看人次、观看人数、观看人数峰值、累计观看时长、人均观看时长和人均观看次数

DataType

Integer

是

1

直播间数据类型。目前仅支持取值 1，即直播间的以下基础数据。

页面访问数据：访问人次、访问人数、访问人数峰值、累计访问时长、人均访问时长、人均访问次数
播放器观看数据：预告、直播、回放和总观看的观看人次、观看人数、观看人数峰值、累计观看时长、人均观看时长和人均观看次数

返回参数

参数	类型	示例值	描述
ExportId	Long	`1877****1234`	导出记录 ID，是导出任务的唯一标识。您可在调用 GetActivityExportFile 接口时传入该 ID，获取导出的数据文件。

请求示例

POST https://livesaas.volcengineapi.com/?Action=ExportActivityData&Version=2023-08-01
{
    "ActivityId": 1856****1234,
    "DataType": 1
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "ExportActivityData",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1697446406
    },
    "Result": {
        "ExportId": 1877****1234
    }
}

错误码

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