GET /dumps

List dumps

List user dumps

Header Parameters

Name Description Type Required Default
Accept-Language Preferred language code in which data shall be returned. Defaults to English if no translation in the specified language is available. Can be used through the query parameter query or using the header Accept-Language.

en - English
zh - Chinese
ru - Russian
id - Indonesian
jp - Japanese
Accepted Values: [ en,zh,ru,id,jp]
String en
Accept Response data format. Default is application/json. Can be used through the query parameter format or using the header Accept.
Accepted Values: [ application/json,application/xml,text/csv]
String json

Query Parameters

Name Description Type Required Default
lang Preferred language code in which data will be returned. Defaults to English if no translation in the language specified is available. Can be used through the query parameter query or using the header Accept-Language.

en - English
zh - Chinese
ru - Russian
id - Indonesian
jp - Japanese
Accepted Values: [ en,zh,ru,id,jp]
String en
format Response data format. Default is json. Can be used through the query parameter format or using the header Accept.
Accepted Values: [ json,xml,csv]
String json
token Access API key. String
with_model_information If set to true returns the model names as part of the response. Boolean false
offset The offset from which the records will be returned. Used to get the next set of records when the limit is reached. Number 0
limit Number of records to return in the range 1 - 100. Default is 100. Number 100
created_after Will return entries created after created_after date String
created_before Will return entries created after created_before date String
filter_id Filter ID used to define a subset of data over which the search will be executed. When combined with additional search criterion, the result will be an intesection of both. String
created_order Choose whether to order the entries ascending or descending. Default is Ascending
Accepted Values: [ ASC,DESC]
String ASC
status Dump status
Accepted Values: [ PENDING_INITIALIZATION,INITIALIZING_SERIES,AWAITING_PROCESSING,RETRIEVING_DATA,CONSOLIDATING_RESULTS,UPLOADING,DONE,ERROR,NOTHING_TO_RETRIEVE,CANCELED]
Array
feed_id Feed ID String

Responses

All API calls have response size limit of 10MB! If you are planning to request a bulky item collection, please consider using the corresponding API request parameters to limit your response.

Status Code Type Type
200 List of dump records for the current user DumpListResult
400 Incorrect input parameters. BadRequest
401 Authorization error. AuthorizationError
403 Incorrect user permissions. PermissionsError
404 Requested entity not found. NotFound
415 Unsupported data format. Only json, xml, csv are supported. UnsupportedMedia
429 Too many requests were send or limit exceeded. TooManyRequests
500 Internal Server Error. InternalError
API Query Builder
Query
Query Result