Exports

Model

Exports Model

The exports model represents an export operation on a specific resource, detailing stats and statuses.

object "export"
The description of the model.

id string
Unique identifier for the export.

organization_id string
Unique identifier for the organization that owns this export.

name string
Name of the export

status queued|processing|completed|failed|timed_out
Current status of the export

reason string
reason, if any, for export failure

created_at integer
Time in epoch seconds when this export was created.

updated_at integer
Time in epoch seconds when this export was last updated.

deleted_at integer
Time in epoch seconds when this export was deleted, if deleted.

updated_by string
ID of the user who last updated the export.

count_total integer
Total number or records in the export.

count_csv_success integer
Number of records successfully exported.

count_csv_error integer
Number of records that errored and could not be exported.

count_csv_sanitized integer
number of records not exported due to data sanitization.

filters object
All the filters and sorting applied on exported dataset.

csv_field_options object

Show Details


csv_field_options.array_fields `skip\|keep\|count_only` specifies how the array fields are represented in the exported data.
csv_field_options.optional_fields `skip\|keep\|count_only` specifies how the array fields are represented in the exported data.
csv_field_options.properties `merge\|flatten` specifies the representation of nested objects or arrays in the data, for distinguishing between `merge` and `flatten` see overview.
csv_field_options.timezone `string(valid IANA Time Zone Database identifier or a UTC offset)` specifies the timezone of dates present in exported data. ex: "UTC", "America/New_York", "+01:00", "-1100", "+03"
csv_field_options.columns `object` specifies columns present in exported data.
csv_field_options.column_order `Array<string>` specifies the order of columns present in exported data.