Download snapshot

Endpoint: GET /datasets/v3/snapshot/:snapshot_id

Download the result of a data collection (snapshot must be in status=ready.)

Path Parameters

snapshot_id
string
required

The ID that was returned when the collection was triggered

Example: s_lynh132v19n82v81kx

Query Parameters

format
enum

Format of the data to be received

Options: json, ndjson, jsonl, csv

Example: format=json

compress
boolean

Whether the result should be compressed or not

Example: compress=true

batch_size
integer

Divide into batches of X records

Example: batch_size=1000

Minimum 1000 records
part
integer

If batch_size was provided, specify which part to download

Example: part=1


Deliver collected data to storage

Endpoint: POST /datasets/v3/deliver/:snapshot_id

Deliver collected data directly to your specified storage location.

Path Parameters

snapshot_id
string
required

The ID that was returned when the collection was triggered

Example: s_lynh132v19n82v81kx

Notify Parameters

notify
url

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

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

Body Parameters (JSON)

deliver
object
required

Delivery settings

Example: {"deliver": {...}}

deliver has the following four child attributes: