一、DT 事件导出 API
如果您需要获取原始上报的事件数据并进行自定义分析,可以使用事件导出 API。
在使用过程中,请注意以下事项:
- 事件导出 API 为异步接口。调用后不会立即返回结果,而是创建一个导出任务,由 DT 后台调度执行。
- 全量数据导出耗时较长,建议合理控制查询时间范围(单次不超过一周)。若需导出较长时间段的数据,建议按时间分段执行。同时,尽量指定事件名称及事件属性,以提升导出效率。
- 创建接口调用频率限制为 1 次/分钟,超出限制的请求将被拦截。
- 导出结果仅保留 24 小时,请及时下载,以免数据失效。
1.1 创建事件导出任务
接口URL
/api/open_api/v1/data-export?token=xxx
请求方式
POST
Content-Type
application/json
请求Query参数
|
参数名
|
参数类型
|
是否必填
|
参数描述
|
|
token
|
String
|
是
|
open-api的查询token
|
请求Body参数
|
参数名
|
参数类型
|
是否必填
|
参数描述
|
| start_date | String | 是 | 导出开始日期,UTC时间,格式:"2026-02-01" |
|
end_date
|
String
|
是
|
导出结束日期,UTC时间,格式:"2026-02-01"
|
|
event_list
|
List[String]
|
否
|
导出指定事件,缺省时为全部预置事件和自定义事件
|
|
property_list
|
List[String]
|
否
|
导出事件的指定属性,缺省时为全部系统属性、预置属性和自定义属性
|
参数说明
start_date、end_date为必传参数,导出的数据范围为闭区间,时区为UTC标准时区,对应事件属性为事件时间(#event_time),即二者同时为"2026-02-01"时,导出的数据的事件时间范围为:[2026-02-01 00:00:00, 2026-02-01 23:59:59],时间跨度不得超过14天。

event_list为非必传参数,有传参时会仅导出传递的该部分事件。可选参数根据项目会有所不同,详细请查看数据引擎->管理->元事件,并筛选预置事件和自定义事件。事件导出不支持虚拟事件的导出。

property_list为非必传参数,有传参时会仅导出传递的该部分事件属性。可选参数根据项目会有所不同,详细请查看数据引擎->管理->事件属性,并筛选系统属性、预置属性和自定义属性。事件属性导出不支持虚拟属性和维度属性的导出。
请求结构示例:
{
"start_date": "2026-02-01",
"end_date": "2026-02-01",
"event_list": [
"#app_install"
],
"property_list": [
"$uid",
"#dt_id",
"#event_name",
"#event_time",
"$server_time",
"#event_syn"
]
}
响应Body参数
|
参数名
|
参数类型
|
参数描述
|
|
data
|
Object
|
|
|
- task_id
|
String
|
当前任务ID
|
响应结构示例:
{
"code": 2000,
"message": "OK",
"data": {
"task_id": "83d87c71-ab80-4590-b615-a9c05280c1ea"
}
}
1.2 查询导出任务的状态
接口URL
/api/open_api/v1/data-export/status?token={token}&task_id={task_id}&show_detail={show_detail}
请求方式
GET
Content-Type
application/json
请求Query参数
|
参数名
|
参数类型
|
是否必填
|
参数描述
|
|
token
|
String
|
是
|
open-api的查询token
|
|
task_id
|
String
|
否
|
查询任务task_id, 缺省时获取完整列表
|
|
show_detail
|
String
|
否
|
true/false,是否展示任务详情,缺省时不展示
|
请求示例:
/api/open_api/v1/data-export/status?token=aaaa&task_id=bbbb&show_detail=true
响应Body参数
| 字段名 | 字段类型 | 字段说明 |
|
data
|
List[Object]
|
导出任务详情组成的列表 |
|
- task_id
|
String
|
任务ID |
|
- status
|
String |
当前任务状态 |
|
- create_time
|
String
|
任务创建时间(show_detail时返回)
|
|
- original_param
|
Object
|
任务创建时请求参数(show_detail时返回) |
|
当
SUCCESS时 |
|
|
|
- file_count
|
Int
|
导出文件数量
|
|
- url_list
|
List[String]
|
导出文件地址
|
当FAILED时 |
||
|
- error_msg
|
String
|
错误详情
|
响应示例:
{
"code": 2000,
"message": "OK",
"data": [
// 成功
{
"task_id": "02a3684a-eaa9-49c4-858f-24973b22249a",
"status": "SUCCESS",
"create_time": "2026-03-17 11:06:29",
"original_param": {
"end_date": "2026-03-01",
"start_date": "2026-03-01",
"property_list": [
"$uid",
"#event_name",
"#event_time",
"#event_syn",
"$server_time",
"#dt_id"
]
},
"file_count": 1,
"url_list": [
"https://dl.datatower.ai/data_export/dt_42fb1405ac975d34/20260318_180413_02a3684a-eaa9-49c4-858f-24973b22249a/file_0001.csv"
]
},
// 失败
{
"task_id": "adb07793-ac76-41bc-a2e3-bbdc51912686",
"status": "FAILED",
"create_time": "2026-03-17 11:09:57",
"original_param": {
"end_date": "2026-03-17",
"start_date": "2026-03-01",
"property_list": [
"$uid",
"#event_name",
"#event_time",
"#event_syn",
"$server_time",
"#dt_id"
]
},
"error_msg": "未知错误"
},
// 执行中
{
"task_id": "aaf07fbc-258f-43e2-a3a2-91358cd9b509",
"status": "RUNNING",
"create_time": "2026-03-17 11:23:16",
"original_param": {
"end_date": "2026-03-17",
"start_date": "2026-03-01",
"property_list": [
"$uid"
]
}
}
]
}