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

埋点数据离线同步

最近更新时间2023.05.12 14:29:27

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

概述

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

说明

  • 开通服务
    • 如需要埋点数据离线同步服务功能,请联系对接同学开通相关服务,交付物为日更新离线文件;T为开通日,T-1标识为开通日的前一日
  • 数据范围
    • 历史 至 T-8数据导出:如需要,可在开通埋点数据同步功能后,请联系对接人员,获取对应离线文件,最远支持导出T-450的历史数据;
    • T-7 至 T-1数据导出:如需要,请联系对接人员开通需要使用埋点数据同步功能的应用(应用ID),通过接口获取功能开通之日后的数据。
调前准备
  1. 接口鉴权
    详见:接口鉴权
  2. 调用接口
    注意参数 是否必填,使用正确的ServiceName、Action、Version 等url信息,详见:下方接口信息。
请求接口

以下T-7 至 T-1 数据自动导出方案,该接口主要用于客户侧通过日期时间段导出埋点数据。

请求方式

post

请求url:

https://cms.volcengineapi.com?Action=HandleDataExporter&Version=2022-01-01

请求header:

ServiceName: volc_content_platform

url组成:

Host: https://cms.volcengineapi.com

Action: HandleDataExporter

Version: 2022-01-01
请求参数

HandleDataExporterRequest

字段名

字段类型

是否必填

说明

AppId

number

需要导出的应用AppId

StartTime

string

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

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

注意

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

响应字段
字段名
字段类型
是否必填
说明
Result
Result
导出结果
ResponseMetadata
ResponseMetadata
同内容引入章节ResponseMetadata字段
请求示例
{
"AppId":123456,
"StartTime":"YYYY-MM-DD",
"EndTime":"YYYY-MM-DD"
}
响应示例
{
    "ResponseMetadata": {
        "RequestId": "202203282100390102111730981D161BE9",
        "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_b6pj3m7emyw5e5e6.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_3zvnvvsd07zhwhi0.csv.gz"
                ]
            },
            ... 
        ]
    }
}
数据字段
字段名称字段类型字段含义
app_install_idstringapp升级id
app_packagestringapp包名称
app_channelstringapp下载渠道
app_idintapp在头条内部的应用id
app_namestringapp的显示名称
app_versionstringapp的版本号
app_languagestringapp的语言
ab_versionstringAB Test
ab_clientstringAB Test
device_idstring设备id
device_ipstring设备ip
device_timezoneint设备所处时区
device_modelstring设备类型
device_brandstring设备品牌
location_provincestring定位省份。##暂不支持,全部为空##
location_citystring定位城市。##暂不支持,全部为空##
os_namestring设备系统名称,ios、android
os_versionstring设备系统版本
os_is_jailbrokenint设备是否越狱,对于ios系统,0-没有越狱,1-越狱;对于android系统,均为0
network_typestring网络类型,2g、3g、4g、wifi、unknown
network_carrierstring网络运营商
session_idstringsession_id
server_timeint日志到达服务器的时间,unixtime格式
screen_resolutionstring屏幕分辨率
screen_densitystring屏幕像素显示级别
screen_idstring事件发生的当前页面。##暂不支持,全部为空##
screen_pre_idstring事件发生的上一个页面。##暂不支持,全部为空##
push_osstring推送的os
push_sdkstring推送的sdk列表
product_idintapp在头条内部的product id
product_namestringapp在头条内部的product name
user_typeint用户类型,头条专用,ttuid中的ut
user_idbigint用户id,头条专用,ttuid中的uid
user_is_authint用户是否授权,头条专用,0-否,1-是
user_unique_idstring用户唯一id,{user_type}_{user_id}
timeint事件在客户端发生的时间,unixtime格式
eventstring事件名称
paramsmap<string,string>客户端上报的params字段
headermap<string,string>客户端上报的header字段
usermap<string,string>客户端上报的user字段
header_custommap<string,string>上报方自定义的公共属性
ssidstring3.0的新id
local_time_msbigint毫秒级别的时间戳
tea_event_indexbigint一个session中事件的发生顺序
错误码
错误码说明
600501日期格式不正确,因为YYYY-MM-DD
600503导出日期超过最大7天范围限制

其他错误可参见:错误代码表