Skip to main content
GET
/
datasets
/
v3
/
progress
/
{snapshot_id}
cURL
curl --request GET \
  --url https://api.brightdata.com/datasets/v3/progress/{snapshot_id} \
  --header 'Authorization: Bearer <token>'
{
  "snapshot_id": "<string>",
  "dataset_id": "<string>",
  "status": "running"
}
  • Asynchronous Usage: Trigger a data collection job via the async endpoint (/trigger), receive a snapshot_id, and poll the Monitor Progress API until the status is ready, then download the results.
  • Synchronous Usage: If a sync request (/scrape) exceeds the 1-minute timeout, receive a snapshot_id to poll the Monitor Progress API and download the results once they are ready.
The Monitor Progress API provides flexibility and stability, allowing efficient handling of large data volumes by differentiating between immediate and delayed result retrievals.
If the request takes too long, we recommend sending an Asynchronous request.

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

​
snapshot_id
string
required

The ID that was returned when the collection was triggered

Example:

"s_m4x7enmven8djfqak"

Response

200 - application/json

OK

​
snapshot_id
string
​
dataset_id
string
​
status
enum<string>

Status of the snapshot

Available options:
running,
ready,
failed