GET
/
datasets
/
v3
/
snapshot
/
{snapshot_id}

If needed, the result can be divided into several parts:

  1. Download the first part by specifying a batch_size and part=1

  2. Check how many part were created using this endpoint

  3. Download the rest of the parts by changing the part parameter. (batch_size, format and compress must stay the same for each call)

Authorizations

​
Authorization
string
headerrequired

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

Query Parameters

​
format
enum<string>

Format of the data to be received

Available options:
json,
ndjson,
jsonl,
csv
​
compress
boolean

Whether the result should be compressed or not

​
batch_size
integer

Divide into batches of X records

Required range: x > 1000
​
part
integer

If batch_size was provided, specify which part to download

Response

200 - application/json

Data in the desired format

Was this page helpful?

Trigger a collectionDeliver snapshot