Exports
Retrieve Exports
This allows you to retrieve details of a specific export and get the exported data/file. "_json_url" will contain url to download exported data in json file provided that "include_csv" is true. "_csv_url" will contain url to download exported data in json file provided that "include_json" is true. "_csv_error_url" will contain url to download a file containing errors occured in export if any, provided that "include_json" is true. "_csv_sanitized_url" will contain url to download data that was excluded from export due to data being potentialy malacious provided that "include_json" is true.. This data is sanitized.
Retrieve Export
Example
Retrieve a single export using its id
.
Query Parameters
include_csv true|false
(default: false)
include_json true|false
(default: false)
List exports
Example
When you want to retrieve list of exports, your data property on the result will always be an array even if you don't have any exports. The exports are returned in chronological order by creation date.
Pagination
If the has_more
property on the pagination object is set to true, you know there are more exports in the database that have not been returned to you. The pagination object also has a page
property indicating your current offset and a limit property. The total_count property in pagination returns the total number of exports in the database.
By default, the page
is set to 1
and the limit
is 10
.
If we want to query for exports 11 - 20, we would request page 2 with a query parameter.
Query Parameters
order_by created_at|count_batches|count_total|updated_at
Specifies the field by which results should be ordered.
direction asc|desc <br> Can be used along with order by to sort results in ascending or descending order. Default
asc`
resource contact|group|location|shipment|tracker|shipping_label_inference
Filters exports based on the resource type.
statuses queued|processing|completed|failed|timed_out
Filters exports by status.
search string
Search by export name.