获取快照

获取已触发采集的列表，该列表仅包含为特定数据集创建的快照

GET /datasets/v3/snapshots

cURL

cURL

curl --request GET \
  --url https://api.brightdata.com/datasets/v3/snapshots \
  --header 'Authorization: Bearer <token>'

200

[
  {
    "id": "<string>",
    "created": "2023-11-07T05:31:56Z",
    "dataset_id": "<string>",
    "dataset_size": 123,
    "trigger": {
      "type": "<string>"
    }
  }
]

授权

Authorization · string · header · 必填

在 Authorization 头中使用您的 Bright Data API Key 作为 Bearer token。

认证方法:

1. 从 Bright Data 账户设置获取您的 API Key: https://brightdata.com/cp/setting/users
2. 在请求的 Authorization 头中包含 API Key
3. 格式: Authorization: Bearer YOUR_API_KEY

示例:

Authorization: Bearer b5648e1096c6442f60a6c4bbbe73f8d2234d3d8324554bd6a7ec8f3f251f07df

了解如何获取 Bright Data API Key: https://docs.brightdata.com/cn/api-reference/authentication#如何生成新的-api-key？

查询参数

dataset_id · string · 必填

数据集标识符（可在具体 API 页面找到）

status · enum<string>

仅列出具有特定状态的快照

可用选项: starting, running, ready, failed

skip · integer · 默认值: 0

跳过前 x 个快照

limit · integer · 默认值: 1000

限制返回的快照数量

必填范围: x <= 5000

from_date · string<date>

仅列出在特定日期之后创建的快照

to_date · string<date>

仅列出在特定日期之前创建的快照

with_total · boolean

如果包含此参数，则返回快照总数

trigger_type · enum<string>

按类型筛选快照

可用选项: ALL, CP, API

响应

200 - application/json

成功

id · string

触发 API 返回的快照 ID

created · string<date-time>

请求采集的时间

status · enum<string>

采集状态

可用选项: starting, running, ready, failed

dataset_id · string

触发采集的数据集 ID

dataset_size · integer

收集的记录数量

trigger · object

Show child attributes