API说明与公共参数--增长分析 DataFinder-火山引擎

文档中心

导航

API说明与公共参数

最近更新时间：2024.06.30 18:36:01首次发布时间：2024.06.30 18:36:01

1. 概述

注意事项
环境支持	本文档为SaaS-非云原生产品原始数据自定义导出的使用文档；私有化版本可以查看私有化API文档：API说明与公共参数2。注意 SaaS-云原生版本暂不支持数据导出。
数据导出方式	通过本API导出数据时，为T+1离线的方式导出原始数据，如果需要实时数据可以查看数据输出。
功能开通	为了保证您和用户的数据安全，应用原始数据导出的接口权限默认是关闭的。在开始使用之前，您需要联系客服开通数据导出功能。

开通原始数据导出功能后，系统会每天自动执行任务，导出前一天数据并上传文件系统，您可以通过该开放接口获取和导出开通之日之后的原始数据。
根据数据时间（当天时间为T），接口分为:

T-7 至 T-1数据导出，对应api为【获取数据文件清单】，数据会由系统定时为您导出，需要注意的是如果数据导出功能开通时间在T-7之后，则只能获取自功能开通之日起的数据；
历史至 T-8数据导出，对应api为【提交自定义数据导出】和【获取自定义导出数据清单】，需要您使用【提交自定义数据导出】提交对应日期的数据导出任务，系统会为您自动导出，导出速率约为1天可以导出单个应用1个月的数据，等待数据导出完成后，使用【获取自定义导出数据清单API】获取数据文件地址，需要注意的是，最远支持导出T-90的历史数据。

2. API 公共参数

Path-parameters:

参数	类型	是否必选	示例值	描述
app_id	int	是	123456	应用的app_id
begin_date	string	是	2024-06-25	yyyy-MM-dd，需要导出数据的开始日期
end_date	string	是	2024-06-30	yyyy-MM-dd，需要导出数据的结束日期。

Response:
```
{
        "code": 200,
        "data": [{REULT_OBJECT}],
        "message": "success"
}
```
- code 状态码，200 表示成功，其他为失败
- message 成功或失败信息
- data 结果数据，为一个json object array

3. API列表

4. 下载数据文件

使用 获取数据文件清单 或者 获取自定义导出数据文件清单 结果返回的urls，依次下载原始数据文件，可以并发下载，建议最多5个线程。
建议每日定时获取前一天的数据。

附：数据文件字段说明

下载后的原始数据文件为csv.gz文件，可以直接导入hdfs，编码为utf-8。
文件字段字段如下：