Skip to main content
GET
/
datasets
/
snapshots
cURL
curl --request GET \
  --url https://api.brightdata.com/datasets/snapshots \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "snap_m2bxug4e2o352v1jv1",
    "created": "2024-01-01T00:00:00Z",
    "status": "ready",
    "dataset_id": "gd_l1viktl72bvl7bjuj0",
    "view_id": "v_m6iezgld2c56zjwchm",
    "dataset_size": 1000
  }
]

Authorizations

​
Authorization
string
header
required

Use your Bright Data API Key as a Bearer token in the Authorization header.

How to authenticate:

  1. Obtain your API Key from the Bright Data account settings at https://brightdata.com/cp/setting/users
  2. Include the API Key in the Authorization header of your requests
  3. Format: Authorization: Bearer YOUR_API_KEY

Example:

Authorization: Bearer b5648e1096c6442f60a6c4bbbe73f8d2234d3d8324554bd6a7ec8f3f251f07df

Learn how to get your Bright Data API key: https://docs.brightdata.com/api-reference/authentication

Query Parameters

​
dataset_id
string

Dataset ID

Example:

"gd_l1viktl72bvl7bjuj0"

​
view_id
string

View ID

Example:

"v_m6iezgld2c56zjwchm"

​
status
enum<string>

Snapshot status

Available options:
canceled,
scheduled,
collecting,
digesting,
validating,
building,
delivering,
pending_discovery_input,
pending_pdp_input,
pending_developer_review,
pending_owner_review,
queued_for_developer_review,
ready,
failed,
rolling_back

Response

200 - application/json

OK

​
id
string
​
created
string<date-time>
​
status
enum<string>
Available options:
canceled,
scheduled,
collecting,
digesting,
validating,
building,
delivering,
pending_discovery_input,
pending_pdp_input,
pending_developer_review,
pending_owner_review,
queued_for_developer_review,
ready,
failed,
rolling_back
​
dataset_id
string
​
view_id
string
​
dataset_size
integer

Number of records in the snapshot