# The export object

An export object is returned as part of the response body of each successful list, retrieve, create or update API call to the `/api/exports` endpoint.

## Fields

| Field                                    | Type       | Description                                                                                                                                                                                         |
| ---------------------------------------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **type**                                 | `string`   | `exports`                                                                                                                                                                                           |
| **id**                                   | `string`   | The export unique identifier                                                                                                                                                                        |
| links.**self**                           | `string`   | The export endpoint URL                                                                                                                                                                             |
| attributes.**resource\_type**            | `string`   | The type of resource being exported.                                                                                                                                                                |
| attributes.**format**                    | `string`   | The format of the export one of 'json' (default) or 'csv'.                                                                                                                                          |
| attributes.**status**                    | `string`   | The export job status. One of 'pending' (default), 'in\_progress', 'interrupted', 'completed', or 'failed'.                                                                                         |
| attributes.**includes**                  | `array`    | List of related resources that should be included in the export (redundant when 'fields' are specified).                                                                                            |
| attributes.**fields**                    | `array`    | List of fields to export for the main and related resources (automatically included). Pass the asterisk '\*' to include all exportable fields for the main and related resources.                   |
| attributes.**filters**                   | `object`   | The filters used to select the records to be exported.                                                                                                                                              |
| attributes.**dry\_data**                 | `boolean`  | 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.**jwt\_filters**              | `boolean`  | Send this attribute to apply JWT scope–based sales channel filtering to the exported data.                                                                                                          |
| attributes.**started\_at**               | `datetime` | Time at which the export was started.                                                                                                                                                               |
| attributes.**completed\_at**             | `datetime` | Time at which the export was completed.                                                                                                                                                             |
| attributes.**estimated\_completion\_at** | `datetime` | Estimated time at which the export should complete (dynamically refres^hed).                                                                                                                        |
| attributes.**interrupted\_at**           | `datetime` | Time at which the export was interrupted.                                                                                                                                                           |
| attributes.**records\_count**            | `integer`  | Indicates the number of records to be exported.                                                                                                                                                     |
| attributes.**processed\_count**          | `integer`  | Indicates how many records have been processed in real time.                                                                                                                                        |
| attributes.**progress**                  | `float`    | The percentage of progress of the export.                                                                                                                                                           |
| attributes.**attachment\_url**           | `string`   | The URL to the output file, which will be generated upon export completion.                                                                                                                         |
| attributes.**errors\_log**               | `object`   | Contains the exports errors, if any.                                                                                                                                                                |
| attributes.**\_start**                   | `boolean`  | Send this attribute if you want to restart an 'interrupted' export.                                                                                                                                 |
| attributes.**\_interrupt**               | `boolean`  | Send this attribute if you want to mark status as 'interrupted'.                                                                                                                                    |
| attributes.**created\_at**               | `datetime` | Time at which the resource was created.                                                                                                                                                             |
| attributes.**updated\_at**               | `datetime` | Time at which the resource was last updated.                                                                                                                                                        |
| attributes.**reference**                 | `string`   | 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**         | `string`   | Any identifier of the third party system that defines the reference code.                                                                                                                           |
| attributes.**metadata**                  | `object`   | 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.                                        |
| relationships.**events**                 | `array`    | The associated events.                                                                                                                                                                              |
| relationships.**versions**               | `array`    | The associated changes.                                                                                                                                                                             |
| relationships.**event\_stores**          | `array`    | The associated event stores.                                                                                                                                                                        |
| meta.**mode**                            | `string`   | The resource environment (can be one of `test` or `live`)                                                                                                                                           |