Data Exports API resource for managing Data Exports.

GET /api/v1/data_exports
List Data Export records.

Params

Param name
Description
Validations
ids
Optional

Return records matching these ids.

Validations:

  • Must be an array of decimal values. EG: [0, 1, 2, 3]
page
Optional

Return the next page of results.

Validations:

  • Must be a number.
per_page
Optional

How many results to return per page. The default is 25.

Validations:

  • Must be a number.
created_at_to
Optional

Date formatted like 2016-01-01 12:25:15 -0500

Validations:

  • Must be a String
created_at_from
Optional

Date formatted like 2016-01-01 12:25:15 -0500

Validations:

  • Must be a String
fulltext
Optional

Search for any record that matches this text

Validations:

  • Must be a String
time_zone
Optional

Date ranges will be parsed using this time zone.

Validations:
columns
Optional
Specify the columns you would like returned by the API for a given resource. Limiting the columns can significantly increase API response time since only the requested data will be processed. columns=uuid,number,created_at

Must be any combination of:

  • id
  • legacy_id
  • type
  • uuid
  • created_at
  • updated_at
  • deleted_at
  • user_updated_at
  • routes_show_path
  • routes_edit_path
  • external_record_id
  • company_id
  • user_id
  • data_type
  • name
  • status
  • created_at_from
  • created_at_to
  • started_at
  • succeeded_at
  • stopped_at
  • total_count
  • export_count
  • export_file_url

Validations:

  • Must be a String
root
Optional

Pass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}

Validations:

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off

GET /api/v1/data_exports/:data_export_id/download
Download the export file. Redirects to a time-limited presigned S3 URL. Returns 404 if the file is not ready.

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