Labs 任务 ID 列表

POST /v3/dataforseo_labs/id_list

本接口用于获取指定时间范围创建的所有 Labs 任务 ID 及数据已成功完成和未完成的任务。

HTTP 方法与路径：POST /v3/dataforseo_labs/id_list

注意事项：

查询时间范围最多可追溯至当前时间前 6 个月。
当 include_metadata 为 true 时支持查询当前时间前 1 个月创建的任务。
每分钟最多调用 10 次。
单次请求最多返回 1000 个任务 ID。
请求体使用 UTF-8 编码的 JSON 数组。

计费说明

本接口本身不收取费用，接口响应中的 cost 通常为 0。扣费以响应头 X-SeerMarTech-Charge-CNY 为准。

请求示例

cURL

bash

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

Python

python

import requests

url = "https://api.seermartech.cn/v3/dataforseo_labs/id_list"

headers = {
    "Authorization": "Bearer smt_live_YOUR_KEY",
    "Content-Type": "application/json",
}

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

response = requests.post(url, headers=headers, json=post_data)
result = response.json()

if result.get("status_code") == 20000:
    print(result)
else:
    print(
        "请求失败，错误码：%s，错误信息：%s"
        % (result.get("status_code"), result.get("status_message"))
    )

TypeScript

typescript

import axios from "axios";

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

axios
  .post(
    "https://api.seermartech.cn/v3/dataforseo_labs/id_list",
    postData,
    {
      headers: {
        Authorization: "Bearer smt_live_YOUR_KEY",
        "Content-Type": "application/json",
      },
    }
  )
  .then((response) => {
    // 处理响应数据
    console.log(response.data);
  })
  .catch((error) => {
    // 处理请求错误
    console.error(error.response?.data || error.message);
  });

请求参数

请求体为 JSON 数组，数组中的每个对象代表一个查询任务。

参数	类型	填	说明
`datetime_from`	string	是	任务创建时间的起始值，用于筛选任务。使用 UTC 格式：`yyyy-mm-dd hh-mm-ss +00:00`。当 `include_metadata=true` 时，起始时间不能早于当前时间前 1 个月；当 `include_metadata=false` 时，不能早于当前时间前 6 个月。示例：`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 数据，主要字段如下：

字段	类型	说明
`version`	string	当前 API 版本。
`status_code`	integer	请求级状态码。完整状态码列表请参考错误码文档。
`status_message`	string	请求级提示信息。
`time`	string	请求总执行时间，单位为秒。
`cost`	float	平台原始 USD 成本兼容字段；人民币实扣以 `X-SeerMarTech-Charge-CNY` 为准。
`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 成本兼容字段；人民币实扣以 `X-SeerMarTech-Charge-CNY` 为准。
`result_count`	integer	`result` 数组中的数量。
`path`	array	请求 URL 路径。
`data`	object	请求中指定的参数。
`result`	array	任务结果数组。

`result` 数组字段

字段	类型	说明
`id`	string	任务 ID。
`url`	string	创建任务时使用的 API 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	任务状态提示信息。
`cost`	float	平台原始 USD 成本兼容字段；人民币实扣以 `X-SeerMarTech-Charge-CNY` 为准。
`metadata`	object	创建任务时提交的参数在 `include_metadata=true` 时返回。

响应示例

json

{
  "version": "0.1.20221214",
  "status_code": 20000,
  "status_message": "Ok.",
  "time": "0.2807 sec.",
  "cost": 0,
  "tasks_count": 1,
  "tasks_error": 0,
  "tasks": [
    {
      "id": "02101735-4426-0398-0000-6533c5212c2a",
      "status_code": 20000,
      "status_message": "Ok.",
      "time": "0.1023 sec.",
      "cost": 0,
      "result_count": 1,
      "path": [
        "v3",
        "dataforseo_labs",
        "id_list"
      ],
      "data": {
        "api": "dataforseo_labs",
        "function": "id_list",
        "datetime_from": "2023-01-11 00:00:00 +00:00",
        "datetime_to": "2023-02-10 17:47:00 +00:00",
        "limit": 100,
        "sort": "desc",
        "include_metadata": true
      },
      "result": [
        {
          "id": "02101735-4426-0398-0000-6533c5212c2a",
          "url": "v3/dataforseo_labs/google/keywords_for_site/live",
          "datetime_posted": "2023-02-10 15:35:51 +00:00",
          "datetime_done": "2023-02-10 15:35:51 +00:00",
          "status": "20000",
          "cost": 0.0103,
          "metadata": {
            "api": "dataforseo_labs",
            "function": "keywords_for_site",
            "se_type": "google",
            "target": "apple.com",
            "language_code": "en",
            "location_code": 2840,
            "include_serp_info": true,
            "include_subdomains": true,
            "filters": [],
            "order_by": [],
            "limit": 3
          }
        }
      ]
    }
  ]
}

状态码与错误处理

status_code=20000 表示请求成功。
请求级错误可通过响应中的 status_code 和 status_message 判断。
单个任务的错误可通过 tasks_error、任务对象中的 status_code 和 status_message 判断。
任务状态码通常位于 10000 至 60000 范围。

实用场景

检索历史任务 ID：按时间范围批量获取已创建任务，便于构建任务审计、追踪和归档系统。
恢复未完成任务：筛选指定时间段尚未完成或返回异常的任务，便于自动重试和异常补偿。
回溯 SEO 数据处理记录：通过 include_metadata 获取任务参数，定位、网站或地区，提升问题排查效率。
分页同步任务数据：结合 limit、offset 和 sort 分页读取大量任务，一次性加载过多记录。
统计任务执行：利用任务状态、创建时间、完成时间和成本字段，分析 SEO 数据采集任务的执行效率与资源消耗。

Labs 任务 ID 列表 ​

计费说明 ​

请求示例 ​

cURL ​

Python ​

TypeScript ​

请求参数 ​

响应结构 ​

tasks 数组字段 ​

result 数组字段 ​

响应示例 ​

状态码与错误处理 ​

实用场景 ​