Get snapshots - Bright Data Docs

cURL

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

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.brightdata.com/datasets/v3/snapshots', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.brightdata.com/datasets/v3/snapshots",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.brightdata.com/datasets/v3/snapshots"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.brightdata.com/datasets/v3/snapshots")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

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

GET

/

datasets

/

v3

/

snapshots

cURL

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

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.brightdata.com/datasets/v3/snapshots', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.brightdata.com/datasets/v3/snapshots",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.brightdata.com/datasets/v3/snapshots"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.brightdata.com/datasets/v3/snapshots")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

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

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

dataset_id

string

required

The dataset identifier (can be found in the specific API page)

status

enum<string>

List only snapshots with a specific status

Available options:

running,

ready,

failed

skip

integer

default:0

Skip the first x snapshots

limit

integer

default:1000

Limit the number of snapshots to return

Required range: x <= 5000

from_date

string<date>

List only snapshots that were created after a specific date

to_date

string<date>

List only snapshots that were created before a specific date

Response

200 - application/json

OK

id

string

Snapshot ID returned by trigger API

created

string<date-time>

When the collection was requested

status

enum<string>

Status of the collection

Available options:

running,

ready,

failed

dataset_id

string

ID of the dataset for which collection was triggered

dataset_size

integer

Amount of records collected