主题
App Data 错误任务查询
POST /v3/app_data/errors
通过本接口,你可以获取最近 7 天在 App Data API 中执行失败的任务信息。
例如:如果你为任务了 webhook(pingback 或 postback),但由于服务器异常未成功接收回调,可以通过本接口拿到失败任务的 ID,再合 /v3/appendix/webhook_resend/ 重新发送 webhook。
如果某个任务未出现在返回列表中,通常表示以下两种之一:
- 该任务并未返回错误;
- 该任务尚未执行完成。
接口说明
- 请求方式:
POST - 请求地址:
https://api.seermartech.cn/v3/app_data/errors - 请求体格式:JSON 数组
[{...}] - 计费说明:本接口本身不收费,响应中的
cost通常为0;扣费以响应头X-SeerMarTech-Charge-CNY为准
请求参数
| 字段名 | 类型 | 说明 |
|---|---|---|
limit | integer | 返回的错误任务最大数量。可选;默认值:1000;最大值:1000 |
offset | integer | 返回结果中的偏移量。可选;默认值:0。例如设置为 10 时,将跳过前 10 条任务,返回之后的数据 |
filtered_function | string | 按指定功能过滤错误任务。可选。用于返回某一类 function 对应的错误记录。你可以获取未过滤结果,再根据响应中的 function 字段值再次筛选。示例:app_data/task_get/advanced、postback_url、pingback_url |
datetime_from | string | 结果过滤起始时间。可选。按 datetime 字段过滤,范围支持最近 7 天的数据;使用 UTC 格式:yyyy-mm-dd hh-mm-ss +00:00。示例:2021-11-15 12:57:46 +00:00 |
datetime_to | string | 结果过滤结束时间。可选。按 datetime 字段过滤,范围支持最近 7 天的数据;使用 UTC 格式:yyyy-mm-dd hh-mm-ss +00:00。示例:2021-11-15 13:57:46 +00:00 |
请求示例
cURL
bash
curl --location --request POST "https://api.seermartech.cn/v3/app_data/errors" \
--header "Authorization: Bearer smt_live_YOUR_KEY" \
--header "Content-Type: application/json" \
--data-raw '[
{
"limit": 10,
"offset": 0,
"filtered_function": "pingback_url"
}
]'Python
python
import requests
url = "https://api.seermartech.cn/v3/app_data/errors"
headers = {
"Authorization": "Bearer smt_live_YOUR_KEY",
"Content-Type": "application/json"
}
data = [
{
"limit": 10,
"offset": 0,
"filtered_function": "pingback_url"
}
]
response = requests.post(url, headers=headers, json=data)
print(response.json)TypeScript
typescript
import axios from "axios";
const postData = [
{
limit: 10,
offset: 0,
filtered_function: "pingback_url"
}
];
axios({
method: "post",
url: "https://api.seermartech.cn/v3/app_data/errors",
headers: {
Authorization: "Bearer smt_live_YOUR_KEY",
"Content-Type": "application/json"
},
data: postData
})
.then((response) => {
// 输出接口结果
console.log(response.data);
})
.catch((error) => {
console.error(error);
});响应说明
接口返回 JSON 数据,顶层 tasks 数组,用于承载本次获取结果。
顶层字段
| 字段名 | 类型 | 说明 |
|---|---|---|
version | string | 当前 API 版本 |
status_code | integer | 局状态码。完整错误码说明见参考文档 /v3/appendix/errors |
status_message | string | 局状态信息。完整说明见参考文档 /v3/appendix/errors |
time | string | 总执行时间,单位秒 |
cost | float | 本次请求总成本,单位 USD |
tasks_count | integer | tasks 数组中的任务数量 |
tasks_error | integer | tasks 数组中返回错误的任务数量 |
tasks | array | 任务结果数组 |
tasks 数组字段
| 字段名 | 类型 | 说明 |
|---|---|---|
id | string | 任务唯一标识,UUID 格式 |
status_code | integer | 任务状态码,范围通常为 10000-60000 |
status_message | string | 任务状态信息 |
time | string | 任务执行时间,单位秒 |
cost | float | 该任务成本,单位 USD |
result_count | integer | result 数组中的数量 |
path | array | 请求路径 |
data | array / object | 与提交请求时相同的参数 |
result | array | 错误结果明细 |
result 数组字段
| 字段名 | 类型 | 说明 |
|---|---|---|
id | string | 任务 ID |
datetime | string | 错误发生时间,UTC 格式:yyyy-mm-dd hh-mm-ss +00:00。示例:2019-11-15 12:57:46 +00:00 |
function | string | 对应的 API 功能名称 |
error_code | integer | 错误码 |
error_message | string | 错误信息,或触发错误的 URL |
http_url | string | 触发错误的 URL。可能是你调用 API 的请求地址,也可能是 pingback / postback 回调地址 |
http_method | string | HTTP 方法 |
http_code | integer | HTTP 状态码 |
http_time | float | HTTP 请求耗时。对于了 pingback / postback 的任务,这里表示你的服务器响应回调所花费的时间 |
http_response | string | 服务器返回 |
响应示例
json
{
"version": "0.1.20220321",
"status_code": 20000,
"status_message": "Ok.",
"time": "0.1538 sec.",
"cost": 0,
"tasks_count": 1,
"tasks_error": 0,
"tasks": [
{
"data": {
"api": "app_data",
"function": "errors",
"limit": 10,
"offset": 0,
"filtered_function": "pingback_url"
},
"result": []
}
]
}使用建议
量拉取,再按功能过滤 初次排查时,建议不传
filtered_function,查看错误类型;确认问题集中在哪类功能后,再按function精准筛选。结合时间窗口缩小排查范围 使用
datetime_from和datetime_to可以快速定位某次发布、某个障时段的异常任务。合 webhook 重发接口处理回调失败 如果错误来源于
pingback_url或postback_url,可根据返回的任务 ID 进行回调补发,减少数据丢失。
常见状态与错误说明
20000:请求成功- 状态码:表示请求或任务层面存在异常,建议结合以下字段排查:
- 顶层:
status_code、status_message - 任务层:
status_code、status_message - 结果层:
error_code、error_message、http_code、http_response
完整错误码定义可参考 /v3/appendix/errors。
实用场景
- 排查回调失败任务:筛选
pingback_url或postback_url错误,快速定位未送达的异步结果,减少任务结果遗漏。 - 重发异常 webhook:获取失败任务 ID,再调用
/v3/appendix/webhook_resend/进行补发,提升数据链路稳定性。 - 定位接口调用异常:根据
http_code、http_response和error_message分析请求失败原因,缩短 API 联调时间。 - 监控特定功能错误率:通过
filtered_function按功能统计错误任务,识别高障接口或不稳定回调。 - 回溯障时间窗口:结合
datetime_from与datetime_to查询指定时段的失败记录,用于发布后巡检与复盘。