数据删除 OpenAPI 支持通过系统调用创建数据删除任务,借助此功能,能够实现自动化创建数据删除任务,避免人工定期删除数据的重复操作。
通过OpenAPI删除数据,您依然需要知晓数据删除的风险,需要做好充分的验证工作。
(1)对于已使用被删除数据的看板、例行分群任务等,查询结果将受影响
(2)行为事件数据可能被多平台使用,包括但不限于:用户增长分析平台、客户数据平台、A/B实验智能引擎、智能数据洞察、广告监测平台、增长营销平台等,数据删除前请确认不影响上述平台用户的使用
其他注意事项请参见数据删除文档。
Path:/openapi/v1/{app_id}/data_governance/delete_task
Method: POST
Content-type: application/json
请求参数:
请求参数
参数名 | 数据类型 | 描述是否必填 | 描述 |
---|---|---|---|
app_id | int | true | app_id |
start_date | str | true | 开始日期 |
end_date | str | true | 截止日期 (从性能角度考虑,开始日期-截止日期 不超过30天) |
event_list | list | false | 需要删除的事件列表 (如全部删除可为空) |
is_dry_run | boolean | true | 是否预执行:
|
校验规则说明
从性能角度、删除时效的角度,设置了如下的校验规则,校验通过后方可创建删除任务
校验类型 | 校验结果 |
---|---|
时间跨度过大 | {"code": 400, "message": "时间范围超限", "data": {}, "errors": []} |
任务超过10个 | {"code": 400, "message": "任务超限", "data": {}, "errors": []} |
数据存在于待执行任务中 | {"code": 400, "message": "以下数据已存在于其他任务中,请修改范围或待前序任务执行完毕再提交\n时间:2025-05-02~2025-05-02\n事件名称:全部事件", "data": {}, "errors": []} |
删除的事件数量为0 | {"code": 400, "message": "任务无效,预计删除数据条数为0,请调整范围", "data": {}, "errors": []} |
请求示例
{ "app_id": 123, //app_id, 123为示例,请填写您的app_id "start_date": "2025-05-01", //开始日期 "end_date": "2025-05-01", //截止日期 (开始日期-截止日期不超过30天) "event_list": [ //需要删除的事件列表 (如全部删除可为空) ], "is_dry_run": true //true: 预执行, false: 直接提交执行 }
response:
返回参数
参数名 | 数据类型 | 描述 | |
---|---|---|---|
code | int | 返回状态码 | |
message | string | 返回信息 | |
data | object | 查询结果数据 | |
id | int | 数据删除任务id | |
delete_count | int | 实际删除的数据条数 |
返回示例
{"code": 200, "message": "success", "data": {"id": 150291, "delete_count": 88}}