主题
Keywords Data 错误任务查询
通过调用本接口,你可以查询过去 7 天在 Keywords Data API 中执行失败的任务信息。
例如,当你为任务了 webhook(pingback 或 postback),但由于服务端异常未收到回调时,可以通过本接口获取失败任务的 ID,再结合 /v3/appendix/webhook_resend/ 重新发送 webhook。
如果某个任务未出现在返回列表中,通常表示该任务没有报错,或尚未执行完成。
接口说明
- 请求方式:
POST - 接口地址:
https://api.seermartech.cn/v3/keywords_data/errors - 请求体格式:
application/json - 请求体结构:JSON 数组
[{ ... }] - 时间范围:支持查询最近 7 天的错误任务
- 计费说明:调用本接口不收费,扣费以响应头
X-SeerMarTech-Charge-CNY为准
请求参数
| 字段名 | 类型 | 说明 |
|---|---|---|
limit | integer | 返回错误任务的最大数量。可选;默认值:1000;最大值:1000 |
offset | integer | 返回结果的偏移量。可选;默认值:0。例如设置为 10 时,将跳过前 10 条结果并返回后续数据 |
filtered_function | string | 按指定功能过滤错误任务。可用来查看某类失败任务;可根据响应结果中的 function 字段值进行过滤。示例:keywords_data/keywords_for_site/task_post、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 |
响应结构
接口返回 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,完整列表请参考 /v3/appendix/errors |
status_message | string | 任务状态信息,完整列表请参考 /v3/appendix/errors |
time | string | 任务执行时间,单位秒 |
cost | float | 该任务费用,单位 USD |
result_count | integer | result 数组中的数量 |
path | array | 请求路径 |
data | array | 与提交请求时相同的参数数据 |
result | array | 错误结果列表 |
tasks[].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 时使用的 URL,也可能是 pingback / postback 回调地址 |
http_method | string | HTTP 方法 |
http_code | integer | HTTP 状态码 |
http_time | float | HTTP 请求耗时。对于了 pingback / postback 的任务,该字段表示你的服务器响应所花费的时间 |
http_response | string | 服务器返回 |
请求示例
cURL
bash
curl --location --request POST "https://api.seermartech.cn/v3/keywords_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/keywords_data/errors"
headers = {
"Authorization": "Bearer smt_live_YOUR_KEY",
"Content-Type": "application/json"
}
payload = [
{
"limit": 10,
"offset": 0,
"filtered_function": "pingback_url"
}
]
response = requests.post(url, json=payload, headers=headers)
print(response.json)TypeScript
typescript
import axios from "axios";
const payload = [
{
limit: 10,
offset: 0,
filtered_function: "pingback_url"
}
];
axios({
method: "post",
url: "https://api.seermartech.cn/v3/keywords_data/errors",
headers: {
Authorization: "Bearer smt_live_YOUR_KEY",
"Content-Type": "application/json"
},
data: payload
})
.then((response) => {
// 输出返回结果
console.log(response.data);
})
.catch((error) => {
console.error(error);
});响应示例
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": "keywords_data",
"function": "errors",
"limit": 10,
"offset": 0,
"filtered_function": "pingback_url"
},
"result": []
}
]
}状态码说明
20000:请求成功- 状态码及错误信息请参考
/v3/appendix/errors
使用说明
- 本接口适合排查最近 7 天的失败任务。
- 如果你开启了
pingback_url或postback_url,可通过filtered_function精准筛选回调失败记录。 - 查询到失败任务 ID 后,可进一步调用
/v3/appendix/webhook_resend/重发 webhook。 - 若某任务未在结果中出现,不代表数据丢失,可能只是尚未完成或未发生错误。
实用场景
- 排查回调失败任务:筛选
pingback_url或postback_url错误,快速定位未成功通知的任务,业务系统漏单或数据未库。 - 重发异常 webhook:获取失败任务 ID,再调用 webhook 重发接口恢复回调链路,减少人工干预。
- 监控接口稳定性:按时间范围拉取错误任务,统计某一时段的失败分布,用于发现平台请求或自身服务异常。
- 定位错误来源 URL:结合
http_url、http_code、http_response判断是 API 请求失败还是回调地址异常,加快问题修复。 - 筛选特定功能障:通过
filtered_function聚焦某个数据功能的错误记录,便于专项排查某类采集或分析任务。