POST
/
datasets
/
v3
/
deliver
/
{snapshot_id}
curl --request POST \
  --url https://api.brightdata.com/datasets/v3/deliver/{snapshot_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "deliver": {
    "type": "webhook",
    "filename": {
      "template": "<string>",
      "extension": "json"
    },
    "endpoint": "<string>"
  },
  "compress": false
}'
{
  "delivery_id": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
snapshot_id
string
required

The ID that was returned when the collection was triggered

Example:

"s_m4x7enmven8djfqak"

Query Parameters

​
notify
string

URL where a notification will be sent once the delivery is finished

Example:

"https://notify-me.com/"

Body

application/json
​
deliver
object

Deliver configuration

​
compress
boolean
default:false

Deliver file compressed in gzip format

Response

200 - application/json
OK
​
delivery_id
string

ID of your delivery request that can be used in Monitor Delivery API

Was this page helpful?

Download snapshotMonitor progress