The export object
A comprehensive list of the export resource's attributes and relationships
An export object is returned as part of the response body of each successful list, retrieve or create API call to the /api/exports
endpoint.
Fields
Field | Type | Description |
---|---|---|
type |
|
|
id |
| The export unique identifier |
links.self |
| The export endpoint URL |
attributes.attachment_url |
| The URL to the output file, which will be generated upon export completion. |
attributes.completed_at |
| Time at which the export was completed. |
attributes.created_at |
| Time at which the resource was created. |
attributes.dry_data |
| Send this attribute if you want to skip exporting redundant attributes (IDs, timestamps, blanks, etc.), useful when combining export and import to duplicate your dataset. |
attributes.filters |
| The filters used to select the records to be exported. |
attributes.format |
| The format of the export one of 'json' (default) or 'csv'. |
attributes.includes |
| List of related resources that should be included in the export. |
attributes.interrupted_at |
| Time at which the export was interrupted. |
attributes.metadata |
| Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format. |
attributes.records_count |
| Indicates the number of records to be exported. |
attributes.reference |
| A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever. |
attributes.reference_origin |
| Any identifier of the third party system that defines the reference code. |
attributes.resource_type |
| The type of resource being exported. |
attributes.started_at |
| Time at which the export was started. |
attributes.status |
| The export job status. One of 'pending' (default), 'in_progress', 'interrupted', or 'completed'. |
attributes.updated_at |
| Time at which the resource was last updated. |
relationships.events |
| The associated events. |
meta.mode |
| The resource environment (can be one of |
Last updated