POST /api/v1/data_exports
Create a one-time data export. The export runs asynchronously. Poll GET /v1/data_exports/:id for status updates, then download the file via GET /v1/data_exports/:id/download once complete.

Params

Param name
Description
Validations
data_type
Required

The type of data being exported.

Validations:

  • Must be a String
name
Optional Blank Value Allowed

Name of the export.

Validations:

  • Must be a String
created_at_from
Optional Blank Value Allowed

Start of the date range filter for exported records.

Validations:

  • Must be a String
created_at_to
Optional Blank Value Allowed

End of the date range filter for exported records.

Validations:

  • Must be a String
created_at_label
Optional Blank Value Allowed

A named time range (e.g. today, last-week, this-month). When provided and created_at_from/created_at_to are blank, the label is parsed into a date range.

Validations:

  • Must be a String
column_names
Optional Blank Value Allowed

Array of column names to include in the export. Defaults to all available columns for the data type if omitted.

Validations:

  • Must be an array of any type
serializer_type
Optional Blank Value Allowed

Serializer format for the export (e.g. call_grid for calls).

Validations:

  • Must be a String