App Data 任务 ID 列表

POST /v3/app_data/id_list

接口说明

/v3/app_data/id_list 用于获取指定时间范围创建的 App Data 任务列表，返回任务 ID 及数据。该接口会同时返回已成功和未完成的任务。

需要注意：

• 可查询的时间范围最长为最近 6 个月
• 只有在 include_metadata=true 时才会返回任务数据 -数据适用于最近 1 个月创建的任务

请求方式

POST https://api.seermartech.cn/v3/app_data/id_list

计费与频率限制

• 本接口使用
• 调用频率上限：10 次/分钟
• 单次调用最多可返回 1000 个任务 ID
• 实扣费以响应头 X-SeerMarTech-Charge-CNY 为准

请求体格式

所有 POST 数据需使用 UTF-8 编码的 JSON 格式提交，请求体为 JSON 数组：

[
 {
 "datetime_from": "2023-01-31 00:00:00 +02:00",
 "datetime_to": "2023-02-01 00:00:00 +02:00",
 "limit": 100,
 "offset": 0,
 "sort": "desc",
 "include_metadata": true
 }
]

请求参数

字段名	类型	说明
datetime_from	string	结果筛选的开始时间。填。当 include_metadata=true 时，最早只能指定为当前时间往前 1 个月；当 include_metadata=false 时，最早可指定为当前时间往前 6 个月。使用 UTC 时间格式：yyyy-mm-dd hh-mm-ss +00:00。示例：2023-01-15 12:57:46 +00:00
datetime_to	string	结果筛选的结束时间。填。最大值为当前时间。使用 UTC 时间格式：yyyy-mm-dd hh-mm-ss +00:00。示例：2023-01-31 13:57:46 +00:00
limit	integer	返回任务 ID 的最大数量。可选，默认 1000，最大 1000
offset	integer	返回结果中的偏移量。可选，默认 0。例如设置为 10 时，将跳过前 10 条任务记录
sort	string	按任务执行时间排序。可选。取值："asc"、"desc"，默认 "asc"
include_metadata	boolean	是否在响应中任务数据。可选，默认 false

响应结构

接口返回 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	URL 路径
data	object	与请求中提交参数相同的对象
result	array	结果数组

result 数组字段

字段名	类型	说明
id	string	任务 ID
url	string	任务请求地址，即调用本接口时使用的 URL
datetime_posted	string	任务创建时间，UTC 格式：yyyy-mm-dd hh-mm-ss +00:00
datetime_done	string	任务完成时间，UTC 格式：yyyy-mm-dd hh-mm-ss +00:00
status	string	任务状态信息，完整列表参考 /v3/appendix-errors/
cost	float	任务费用，单位 USD
metadata	object	任务数据，对应创建任务时提交的参数；在 include_metadata=true 且任务在可用时间范围时返回

请求示例

cURL

curl --location --request POST "https://api.seermartech.cn/v3/app_data/id_list" \
--header "Authorization: Bearer smt_live_YOUR_KEY" \
--header "Content-Type: application/json" \
--data-raw '[
 {
 "datetime_from": "2023-01-31 00:00:00 +02:00",
 "datetime_to": "2023-02-01 00:00:00 +02:00",
 "limit": 100,
 "offset": 0,
 "sort": "desc",
 "include_metadata": true
 }
]'

Python

import requests

url = "https://api.seermartech.cn/v3/app_data/id_list"
payload = [
 {
 "datetime_from": "2023-01-31 00:00:00 +02:00",
 "datetime_to": "2023-02-01 00:00:00 +02:00",
 "limit": 100,
 "offset": 0,
 "sort": "desc",
 "include_metadata": True
 }
]
headers = {
 "Authorization": "Bearer smt_live_YOUR_KEY",
 "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)
print(response.json)

TypeScript

import axios from "axios";

const postData = [
 {
 datetime_from: "2023-01-31 00:00:00 +02:00",
 datetime_to: "2023-02-01 00:00:00 +02:00",
 limit: 100,
 offset: 0,
 sort: "desc",
 include_metadata: true
 }
];

axios({
 method: "post",
 url: "https://api.seermartech.cn/v3/app_data/id_list",
 headers: {
 Authorization: "Bearer smt_live_YOUR_KEY",
 "Content-Type": "application/json"
 },
 data: postData
})
 .then((response) => {
 // 输出接口返回结果
 console.log(response.data);
 })
 .catch((error) => {
 console.error(error);
 });

响应示例

{
 "version": "0.1.20221214",
 "status_code": 20000,
 "status_message": "Ok.",
 "time": "0.5931 sec.",
 "cost": 0,
 "tasks_count": 1,
 "tasks_error": 0,
 "tasks": [
 {
 "data": {
 "api": "app_data",
 "function": "id_list",
 "datetime_from": "2023-01-11 00:00:00 +02:00",
 "datetime_to": "2023-02-10 17:47:00 +02:00",
 "limit": 100,
 "sort": "desc",
 "include_metadata": true
 },
 "result": []
 }
 ]
}

状态码说明

• 顶层 status_code=20000 表示请求成功
• 各任务对象也会返回独立的 status_code 和 status_message
• 完整错误码及状态说明请参考 /v3/appendix/errors 与 /v3/appendix-errors/

使用说明与注意事项

1. datetime_from 和 datetime_to须按指定时间格式传
2. 若需要获取 metadata，请将 include_metadata 设为 true
3. 当 include_metadata=true 时，查询起始时间不能早于当前时间往前 1 个月
4. 分页请结合 limit 和 offset 使用
5. 单次最多返回 1000 条记录，批量拉取历史任务时建议循环分页请求

实用场景

• 回溯任务执行记录：按时间窗口批量拉取历史 App Data 任务 ID，便于审计采集流程和排查漏采任务
• 筛选异常或未完成任务：获取指定时间的任务列表后，结合状态字段定位失败、处理中或未完成任务，提升运维排障效率
• 恢复任务上下文：开启 include_metadata 后取回任务参数，快速还原历史任务的查询条件，方便复跑和结果复核
• 构建任务台账：按分页持续同步任务 ID、创建时间和完成时间，沉淀为任务日志或数据资产目录
• 监控批量采集稳定性：周期性拉取最近任务列表，对比 posted/done 时间和状态变化，评估接口调用稳定性与处理时效