获取直播间导出数据文件--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

获取直播间导出数据文件

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

在调用 ExportActivityData 接口导出直播间数据后，调用 GetActivityExportFile 接口获取导出的数据文件。

注意事项

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

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetActivityExportFile`	接口名称。当前 API 的名称为 `GetActivityExportFile`。
Version	String	是	`2023-08-01`	接口版本。当前 API 的版本为 `2023-08-01`。
ActivityId	Long	是	`1856****1234`	直播间 ID。您可通过调用 ListActivityAPI 接口获取 ID。
ExportId	Long	是	`1877****1234`	导出记录 ID，是导出任务的唯一标识。您可通过调用 ExportActivityData 接口获取 ID。

返回参数

参数类型示例值描述

参数	类型	示例值	描述
Status	Integer	`2`	导出状态。取值如下： `1`：导出中 `2`：导出成功 `3`：导出失败
FileUrl	String	`https://livesaas-medialib.tos-cn-beijing.volces.com/18161459**4970lb9bazqe/query_total_2024-11-20.xlsx?X-Tos-Algorithm=TOS4-HMAC-SHA256&X-Tos-Credential=AKLY%2F20241120%2Fcn-beijing%2Ftos%2Frequest&X-Tos-Date=20241120T070515Z&X-Tos-Expires=15552000&X-Tos-Signature=ae4ecb06606598920b8b3d429fe1ae**28366586da44f1d5b2b20cce749943&X-Tos-SignedHeaders=host`	导出的数据文件链接，文件格式为 XLSX。链接包含协议头，有效期为 180 天。说明仅在 `Status` 取值为 `2` 时，该参数有值。
DataType	Integer	`1`	直播间数据类型。目前仅支持取值 `1`，即直播间的以下基础数据。页面访问数据：访问人次、访问人数、访问人数峰值、累计访问时长、人均访问时长、人均访问次数播放器观看数据：预告、直播、回放和总观看的观看人次、观看人数、观看人数峰值、累计观看时长、人均观看时长和人均观看次数

Status

Integer

2

导出状态。取值如下：

1：导出中
2：导出成功
3：导出失败

FileUrl

String

https://livesaas-medialib.tos-cn-beijing.volces.com/18161459****4970lb9bazqe/query_total_2024-11-20.xlsx?X-Tos-Algorithm=TOS4-HMAC-SHA256&X-Tos-Credential=AKL****Y%2F20241120%2Fcn-beijing%2Ftos%2Frequest&X-Tos-Date=20241120T070515Z&X-Tos-Expires=15552000&X-Tos-Signature=ae4ecb06606598920b8b3d429fe1ae****28366586da44f1d5b2b20cce749943&X-Tos-SignedHeaders=host

导出的数据文件链接，文件格式为 XLSX。链接包含协议头，有效期为 180 天。

说明

仅在 Status 取值为 2 时，该参数有值。

DataType

Integer

1

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

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

请求示例

GET https://livesaas.volcengineapi.com/?Action=GetActivityExportFile&Version=2023-08-01&ActivityId=1856****1234&ExportId=1877****1234

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "GetActivityExportFile",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1697446406
    },
    "Result": {
        "Status": 2,
        "FileUrl": "https://livesaas-medialib.tos-cn-beijing.volces.com/18161459****4970lb9bazqe/query_total_2024-11-20.xlsx?X-Tos-Algorithm=TOS4-HMAC-SHA256&X-Tos-Credential=AKL****Y%2F20241120%2Fcn-beijing%2Ftos%2Frequest&X-Tos-Date=20241120T070515Z&X-Tos-Expires=15552000&X-Tos-Signature=ae4ecb06606598920b8b3d429fe1ae****28366586da44f1d5b2b20cce749943&X-Tos-SignedHeaders=host",
        "DataType": 1
    }
}

错误码

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