Get snapshot metadata - Bright Data Docs

cURL

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

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

fetch('https://api.brightdata.com/datasets/snapshots/{id}', 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/snapshots/{id}",
  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/snapshots/{id}"

	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/snapshots/{id}")

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": "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>"
}

"snapshot not found"

GET

/

datasets

/

snapshots

/

{id}

cURL

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

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

fetch('https://api.brightdata.com/datasets/snapshots/{id}', 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/snapshots/{id}",
  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/snapshots/{id}"

	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/snapshots/{id}")

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": "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>"
}

"snapshot not found"

Authorizations

Authorization

string

header

required

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

How to authenticate:

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

Example:

Authorization: Bearer YOUR_API_KEY

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