Skip to main content
GET
/
datasets
/
snapshots
/
{id}
cURL
curl --request GET \
  --url https://api.brightdata.com/datasets/snapshots/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "created": "2023-11-07T05:31:56Z",
  "status": "scheduled",
  "dataset_id": "<string>",
  "customer_id": "<string>",
  "dataset_size": 123,
  "file_size": 123,
  "cost": 123,
  "error": "<string>",
  "error_code": "<string>",
  "warning": "<string>",
  "warning_code": "<string>",
  "initiation_type": "<string>"
}

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

Path Parameters

​
id
string
required

A Snapshot ID is a unique identifier for a specific data snapshot, used to retrieve results from a data collection job triggered via the API. Read more about Snapshot ID.

Example:

"snap_m2bxug4e2o352v1jv1"

Response

OK

​
id
string
​
created
string<date-time>
​
status
enum<string>
Available options:
scheduled,
building,
ready,
failed
​
dataset_id
string
​
customer_id
string
​
dataset_size
integer

Number of records in the snapshot

​
file_size
integer

Size of the snapshot file in bytes

​
cost
number
​
error
string
​
error_code
string
​
warning
string
​
warning_code
string
​
initiation_type
string