Skip to content
Developer

Download a collection

POST
/download-collection

Download a larger collection of values.

Parameters

Section titled “ Parameters ”

Header Parameters

Section titled “Header Parameters ”
dynata-expiration
required
string format: date-time

RFC3339 timestamp indicating request expiration

dynata-access-key
required
string

Dynata provided access key

Example
ADSF23ADF354GFDDS23
dynata-signature
required
string

Signature created using the Dynata methodology

Example
dsklj435kljhfdSAFdsalk34

Request Body required

Section titled “Request Body required ”
object
id
required

Unique identifier of collection

string
23947683

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Download completed successfully

Headers

Section titled “Headers ”
status
string
Allowed values: AVAILABLE EMPTY_PAYLOAD
Transfer-Encoding
string

Chunked

204

Section titled “204 ”

Processing time will vary by collection. 

The fetched collection is being processed. Try again in 5 to 10 seconds.

Headers

Section titled “Headers ”
status
string
Allowed values: PROCESSING

400

Section titled “400 ”

Bad request

object
message
required

A human readable description of the error

string

401

Section titled “401 ”

Invalid credentials

object
message
required

A human readable description of the error

string

403

Section titled “403 ”

Unauthorized

object
message
required

A human readable description of the error

string

404

Section titled “404 ”

Collection not found

object
error
required
string
Allowed values: collection with id {collection_id} was not found

500

Section titled “500 ”

Internal server error

object
message
required

A human readable description of the error

string

Headers

Section titled “Headers ”
status
string
Allowed values: NOT_AVAILABLE