引力引擎支持使用 API 方式直接导出应用内用户行为事件,导出用户行为事件接口会返回导出任务的任务ID,您可以根据此ID查询事件导出任务进度。
在开始对接此接口前,建议您先阅读数据规则章节,在熟悉 引力引擎 的数据格式与数据规则后,再阅读本指南进行对接。
申请引力开发者应用
在正式接入本接口之前,您需要在引力后台-引力开发者页面申请引力开发者应用,申请之后,我们将在一个工作日内完成审核,审核通过之后,您的开发者应用才可以正常拉取数据。
创建好开发者应用之后,请复制app_key参数,并发送给研发同学以供后续接口调用使用。
接口限频
默认接口限频:每 10 分钟 1 次,接口限频是按开发者应用维度,即同一个app_key下限频共用同一套频次统计。如果开发者绑定应用过多,导致频繁触发限频,请联系引力运营评估后提升限频等级。
接口信息
接口地址
https://api.insight.gravity-engine.com/openapi/api/v1/download/event/query_result/
请求方法
POST
请求参数
Header 参数
| 字段 | 类型 | 描述 |
| Authorization | string | 具体如何生成,请参考【签名生成】 |
Body 参数
| 字段 | 必填 | 参数类型 | 描述 |
| task_id | Y | string | 应用事件导出的任务ID |
| sign | Y | string | 签名,详情请参考【签名生成】 |
请求示例
curl --location --request POST 'https://api-insight.gravity-engine.com/openapi/api/v1/download/event_user/query_result/' \
--header 'Authorization: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhcHBfa2V5IjoiMWMyOGU2MDNlNzE2NGNiYWFjZWEwMGU5ODkxNTNhNGQifQ.7ak-9PE9mMK3VPQ0aYkwRxXuP2xFCgqpr6pncC1TMYc' \
--header 'Content-Type: application/json' \
--header 'Accept: */*' \
--header 'Host: api-insight.gravity-engine.com' \
--header 'Connection: keep-alive' \
--data-raw '{
"sign": "7507a7a1c8234748b8ccc6198c16fe0e",
"task_id": "e69217feac324e4eb7c4b9c0a860711a"
}'
响应参数
| 字段 | 描述 |
| status | 导出作业的状态。取值范围: running = 1 # 处理中
succeed = 2 # 处理完成 failed = 3 # 处理失败 cancel = 4 # 取消下载任务 expire = 5 # 过期 |
| progress | 任务导出进度。取值范围:0-100 |
|
download_url
|
导出文件的下载链接,文件会保存3天,3天后过期删除 |
响应示例
{
"data": {
"task_id": "56b98c5a9a774e458db441d7e9885972",
"status": 2,
"progress": 100, // 进度0-100,
"download_url": "https://gravity-client-resource.oss-cn-hangzhou.aliyuncs.com/264832/excels/事件导出-267493-2025-10-31_12-17-55.csv.gz",
"message": "{}"
},
"extra": null,
"code": 0,
"msg": "成功"
}