Get view delivery settings

Retrieve the current delivery configuration for a Bright Data dataset view (250+ domains): destination, credentials, filename, compression and batch size.

GET /datasets/views/{view_id}/delivery_settings

cURL

cURL

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

import requests

url = "https://api.brightdata.com/datasets/views/{view_id}/delivery_settings"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

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

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

	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))

}

HttpResponse<String> response = Unirest.get("https://api.brightdata.com/datasets/views/{view_id}/delivery_settings")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.brightdata.com/datasets/views/{view_id}/delivery_settings")

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

200

{
  "deliver": {
    "type": "s3",
    "bucket": "bucket_name",
    "credentials": {
      "aws-access-key": "AWS_ACCESS_KEY",
      "aws-secret-key": "AWS_SECRET_KEY"
    },
    "region": "us-east-1",
    "filename": {
      "extension": "json",
      "template": "bd_{[datetime]}",
      "tz_offset": "+04:00"
    },
    "flatten_csv": false
  },
  "tar": false,
  "compress": false,
  "batch_size": 400
}

{
  "error": "View not found"
}

Returns the full delivery configuration stored for the given dataset view. The deliver object contains the destination-specific fields (for example bucket, credentials, region for an S3 destination), and the top-level tar, compress, batch_size and filename fields describe how the output files are packaged.

Find the view_id by calling Get dataset views.

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

view_id · string · required

Unique identifier for the dataset view.

Example:

"v_id1"

Response

200

application/json

Current delivery configuration for the view

Delivery configuration for a dataset view. Used by the view delivery settings GET, PUT and bulk PUT endpoints.

deliver · Microsoft Azure · object

Delivery destination configuration. The type field selects the destination (for example s3, sftp, webhook) and the remaining fields depend on the destination schema returned by /datasets/delivery_settings/{destination_type}/schema.

Microsoft Azure

Build

Email

Google Cloud

Google Cloud PubSub

Amazon S3

SFTP

Snowflake

Webhook

Aliyun Object Storage Service

Show child attributes

filename · object

Configuration for the output file name and format.

Show child attributes

flatten_csv · boolean · default: false

When true, nested fields are flattened for CSV output.

tar · boolean · default: false

When true, delivered files are bundled into a TAR archive.

compress · boolean · default: false

When true, delivered files are gzip compressed.

batch_size · integer

Maximum records per batch file. Use to split large deliveries into smaller files. Maximum batch size is 5GB.

Example:

1000