You need to enable JavaScript to run this app.
导航

HandleDataExporter - 埋点数据离线同步

最近更新时间2024.03.01 10:48:26

首次发布时间2023.05.12 14:29:27

为支持客户沉淀数据资产,基于历史埋点数据进行深度的数据分析,充分发掘用户消费数据的价值,针对购买SAAS版埋点数据离线同步增值服务的客户,内容管理平台支持以离线文件的方式将埋点数据同步给客户。

注意事项

  • 使用限制:

说明

  • 开通服务
    • 如需要埋点数据离线同步服务功能,请联系火山侧产品开通相关服务,交付物为日更新离线文件;T为开通日,T-1标识为开通日的前一日。
  • 数据范围
    • 历史 至 T-8数据导出:如需要,可在开通埋点数据同步功能后,请联系火山侧对接人员,获取对应离线文件,最远支持导出T-450的历史数据;
    • T-7 至 T-1数据导出:如需要,请联系火山侧对接人员开通需要使用埋点数据同步功能的应用(应用ID),通过接口获取功能开通之日后的数据。

请求说明

  • 请求方式:POST
  • 请求地址:https://cms.volcengineapi.com?Action=HandleDataExporter&Version=2022-01-01
  • 请求头:ServiceName: volc_content_platform

请求参数

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

Query

参数
类型
是否必填
示例值
描述
Action
String

HandleDataExporter

要执行的操作,取值:HandleDataExporter

Version
String

2022-01-01

API的版本,取值:2022-01-01

Body

参数
类型
是否必填
示例值
描述
AppId
Long

123456

需要导出的应用AppId。

StartTime
String

开始日期,格式YYYY-MM-DD。

注意

只能导出最近7天的数据,且开始时间和结束时间相隔不能超过7天。

EndTime
String

结束日期,格式YYYY-MM-DD。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构

参数
类型
示例值
描述
Result
ExporterResult

导出结果。

请求示例

{
"AppId":123456,
"StartTime":"YYYY-MM-DD",
"EndTime":"YYYY-MM-DD"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202203282100390102111730981D161***",
        "Action": "HandleDataExporter",
        "Version": "2022-01-01",
        "Service": "volc_content_platform",
        "Region": "cn-north-1"
    },
    "Result": {
        "DataPackets": [
            {
                "Date": "2022-03-21",
                "PacketType": "finder",
                "ExpireTime": 1647820800,
                "Url": [
                    "http://lf6-ttcdn-tos.pstatp.com/obj/dptob-nj-dataexoort/d20220321/origin_event_323310_10__part1_b6pj3m***yw5e5e6.csv.gz"
                ]
            },
            {
                "Date": "2022-03-22",
                "PacketType": "finder",
                "ExpireTime": 1647907200,
                "Url": [
                    "http://lf6-ttcdn-tos.pstatp.com/obj/dptob-nj-dataexoort/d20220322/origin_event_323310_10__part1_3zvnvvsd0***whi0.csv.gz"
                ]
            },
            ... 
        ]
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码
错误码
错误信息
说明
200
600501
日期格式不正确

日期格式不正确,应该为YYYY-MM-DD。

200
600503
导出日期超过最大7天范围限制

导出日期超过最大7天范围限制。