API documentation

GET /data_exports

Authorization Required

https://[your-subdomain].trackdrive.com/api/v1/data_exports

List Data Export records.

List the data exports created in your account, with their status (queued, processing, complete, or stopped) and filters such as date range. Requires the data exports permission.

Params

Param name	Description
ids Optional	Return records matching these ids. Must be an array of decimal values. EG: `[0, 1, 2, 3]`
page Optional	Return the next page of results. Must be a number.
per_page Optional	How many results to return per page. The default is 25. Must be a number.
created_at_to Optional	Date formatted like 2016-01-01 12:25:15 -0500 Must be a String
created_at_from Optional	Date formatted like 2016-01-01 12:25:15 -0500 Must be a String
fulltext Optional	Search for any record that matches this text Must be a String
time_zone Optional	Date ranges will be parsed using this time zone. Must be a valid time zone. See the list of valid time zones.
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 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: {}}` Must be a boolean value: 1, true, yes, on, 0, false, no, off

Example Request

curl 'https://[your-subdomain].trackdrive.com/api/v1/data_exports/?per_page=2' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "data_exports": [
    {
      "id": 10001,
      "type": "DataExport",
      "uuid": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
      "created_at": "2026-01-15T15:30:00.000Z",
      "updated_at": "2026-01-15T15:30:00.000Z",
      "deleted_at": null,
      "user_updated_at": null,
      "routes_show_path": "/data_exports/10001",
      "routes_edit_path": "/data_exports/10001/edit",
      "external_record_id": null,
      "company_id": 10002,
      "user_id": 10003,
      "data_type": "contact",
      "name": "Contact Suppression Export Records Source",
      "status": "complete",
      "created_at_from": "2026-01-15T11:30:00.000Z",
      "created_at_to": "2026-01-15T13:30:00.000Z",
      "started_at": "2026-01-15T13:30:00.000Z",
      "succeeded_at": "2026-01-15T14:30:00.000Z",
      "stopped_at": null,
      "total_count": 4,
      "export_count": 4,
      "export_file_url": null
    },
    {
      "id": 10004,
      "type": "DataExport",
      "uuid": "a09e6bca-255b-4217-af73-cb9601c80217",
      "created_at": "2026-01-15T15:30:00.000Z",
      "updated_at": "2026-01-15T15:30:00.000Z",
      "deleted_at": null,
      "user_updated_at": null,
      "routes_show_path": "/data_exports/10004",
      "routes_edit_path": "/data_exports/10004/edit",
      "external_record_id": null,
      "company_id": 10002,
      "user_id": 10003,
      "data_type": "call",
      "name": "Call Export",
      "status": "complete",
      "created_at_from": "2026-01-15T12:30:00.000Z",
      "created_at_to": "2026-01-15T13:30:00.000Z",
      "started_at": "2026-01-15T13:30:00.000Z",
      "succeeded_at": "2026-01-15T14:30:00.000Z",
      "stopped_at": null,
      "total_count": 25,
      "export_count": 25,
      "export_file_url": null
    }
  ],
  "metadata": {
    "root": "data_exports",
    "page": 1,
    "total_pages": 2,
    "per_page": 2,
    "total_count": 3,
    "next_cursor": 10005
  }
}

GET /data_exports/:data_export_id/download

Authorization Required

https://[your-subdomain].trackdrive.com/api/v1/data_exports/:data_export_id/download

Download a data export file.

Redirects to a time-limited presigned S3 URL for the export file. Returns 404 if the file is not ready.

Example Request

curl 'https://[your-subdomain].trackdrive.com/api/v1/data_exports/10001' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "data_export": {
    "id": 10001,
    "type": "DataExport",
    "uuid": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "created_at": "2026-01-15T15:30:00.000Z",
    "updated_at": "2026-01-15T15:30:00.000Z",
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": "/data_exports/10001",
    "routes_edit_path": "/data_exports/10001/edit",
    "external_record_id": null,
    "company_id": 10002,
    "user_id": 10003,
    "data_type": "contact",
    "name": "Contact Suppression Export Records Source",
    "status": "complete",
    "created_at_from": "2026-01-15T12:30:00.000Z",
    "created_at_to": "2026-01-15T13:30:00.000Z",
    "started_at": "2026-01-15T13:30:00.000Z",
    "succeeded_at": "2026-01-15T14:30:00.000Z",
    "stopped_at": null,
    "total_count": 4,
    "export_count": 4,
    "export_file_url": null
  },
  "metadata": {
    "root": "data_export"
  }
}

POST /data_exports

Authorization Required

https://[your-subdomain].trackdrive.com/api/v1/data_exports

Create a one-time data export

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
data_type Required	The type of data being exported. Must be a String
name Optional Blank value allowed	Name of the export. Must be a String
created_at_from Optional Blank value allowed	Start of the date range filter for exported records. Must be a String
created_at_to Optional Blank value allowed	End of the date range filter for exported records. 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. 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. Must be an array of any type
serializer_type Optional Blank value allowed	Serializer format for the export (e.g. call_grid for calls). Must be a String
time_zone Optional Blank value allowed	Date ranges in the export filters will be parsed using this time zone. Must be a valid time zone. See the list of valid time zones.
notify_emails Optional Blank value allowed	Email addresses to notify when this export finishes.
anonymous_caller Optional Blank value allowed	Match calls where the caller ID was withheld or anonymous. Must be a boolean value: 1, true, yes, on, 0, false, no, off
buyer_attempted Optional Blank value allowed	Match calls where a Buyer was attempted. Must be a boolean value: 1, true, yes, on, 0, false, no, off
buyer_connected Optional Blank value allowed	Match calls where a Buyer connected. Must be a boolean value: 1, true, yes, on, 0, false, no, off
buyer_conversion_duplicated_call Optional Blank value allowed	Match calls where the callerID was a duplicate against the Buyer’s conversion settings. Must be a boolean value: 1, true, yes, on, 0, false, no, off
buyer_repeat_caller Optional Blank value allowed	Match calls where the Buyer had a repeat caller. Must be a boolean value: 1, true, yes, on, 0, false, no, off
disconnected Optional Blank value allowed	Match calls that have disconnected. Must be a boolean value: 1, true, yes, on, 0, false, no, off
finished Optional Blank value allowed	Match leads that have no pending next action, when data_type is lead. Must be a boolean value: 1, true, yes, on, 0, false, no, off
has_barge Optional Blank value allowed	Match calls where a barge occurred (a buyer or agent joined an in-progress call). Must be a boolean value: 1, true, yes, on, 0, false, no, off
has_buyer Optional Blank value allowed	Match calls that connected to a Buyer. Must be a boolean value: 1, true, yes, on, 0, false, no, off
has_call Optional Blank value allowed	Match leads that have at least one call, when data_type is lead. Must be a boolean value: 1, true, yes, on, 0, false, no, off
has_downstream_call Optional Blank value allowed	Match calls that generated a downstream call. Must be a boolean value: 1, true, yes, on, 0, false, no, off
has_email Optional Blank value allowed	Match records that have an email address. Must be a boolean value: 1, true, yes, on, 0, false, no, off
has_next_action Optional Blank value allowed	Match leads that have a pending next action. Must be a boolean value: 1, true, yes, on, 0, false, no, off
has_recording Optional Blank value allowed	Match calls that have a recording. Must be a boolean value: 1, true, yes, on, 0, false, no, off
has_scheduled_callback Optional Blank value allowed	Match calls that have a scheduled callback. Must be a boolean value: 1, true, yes, on, 0, false, no, off
has_traffic_source Optional Blank value allowed	Match calls that have a Traffic Source assigned. Must be a boolean value: 1, true, yes, on, 0, false, no, off
has_voicemail Optional Blank value allowed	Match calls that left a voicemail. Must be a boolean value: 1, true, yes, on, 0, false, no, off
in_progress Optional Blank value allowed	Match calls that are on-going Must be a boolean value: 1, true, yes, on, 0, false, no, off
internal_call Optional Blank value allowed	Match calls that were placed internally rather than by an external caller. Must be a boolean value: 1, true, yes, on, 0, false, no, off
is_scheduled_callback Optional Blank value allowed	Match calls that are themselves a scheduled callback. Must be a boolean value: 1, true, yes, on, 0, false, no, off
left_voicemail Optional Blank value allowed	Match calls that left a voicemail. Must be a boolean value: 1, true, yes, on, 0, false, no, off
manual_opt_in Optional Blank value allowed	Match leads that were manually opted in. Must be a boolean value: 1, true, yes, on, 0, false, no, off
manual_opt_out Optional Blank value allowed	Match leads that were manually opted out. Must be a boolean value: 1, true, yes, on, 0, false, no, off
next_action_ready Optional Blank value allowed	Match leads whose next action is ready to be processed. Must be a boolean value: 1, true, yes, on, 0, false, no, off
offer_conversion_duplicated_call Optional Blank value allowed	Match calls where the callerID was a duplicate against the Traffic Source’s conversion settings. Must be a boolean value: 1, true, yes, on, 0, false, no, off
offer_repeat_caller Optional Blank value allowed	Match calls where the Traffic Source had a repeat caller. Must be a boolean value: 1, true, yes, on, 0, false, no, off
opt_out Optional Blank value allowed	Match leads that are opted out. Must be a boolean value: 1, true, yes, on, 0, false, no, off
outbound_call_from_agent Optional Blank value allowed	Match calls placed outbound by an agent. Must be a boolean value: 1, true, yes, on, 0, false, no, off
placed_on_hold Optional Blank value allowed	Was the call placed on hold? Must be a boolean value: 1, true, yes, on, 0, false, no, off
provider_sms_enabled Optional Blank value allowed	Match records where the provider has SMS enabled. Must be a boolean value: 1, true, yes, on, 0, false, no, off
ring_pool_present Optional Blank value allowed	Match calls that used a Number Pool. Must be a boolean value: 1, true, yes, on, 0, false, no, off
transferred Optional Blank value allowed	Match calls that were transferred. Must be a boolean value: 1, true, yes, on, 0, false, no, off
upstream_number_missing Optional Blank value allowed	Match calls where the upstream Number could not be determined. Must be a boolean value: 1, true, yes, on, 0, false, no, off
buyer_converted_count Optional Blank value allowed	Match calls with this many Buyer conversions. Must be a decimal number.
dial_tier Optional Blank value allowed	Match leads with this dial tier (priority) value. Must be a decimal number.
off_hook_find_a_buyer_attempts_count Optional Blank value allowed	Match calls with this many off-hook find-a-buyer attempts. Must be a decimal number.
offer_converted_count Optional Blank value allowed	Match calls with this many Traffic Source conversions. Must be a decimal number.
response_status Optional Blank value allowed	Match records with this HTTP response status code. Must be a decimal number.
buyer_attempt_id Optional Blank value allowed	Match calls where this Buyer was attempted. Must be a valid foreign key reference to an Buyer. Refer to: /api/docs/1.0/buyers
buyer_group_ids Optional Blank value allowed	Match calls where the Buyer belongs to one of these Buyer Groups. Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an Buyer Group. Refer to: /api/docs/1.0/buyer_groups
buyer_id Optional Blank value allowed	Match calls where this Buyer was the winning Buyer. Must be a valid foreign key reference to an Buyer. Refer to: /api/docs/1.0/buyers
buyer_suppression_id Optional Blank value allowed	Match calls suppressed by this Buyer Suppression list. Must be a valid foreign key reference to an Buyer Suppression. Refer to: /api/docs/1.0/buyer_suppressions
call_center_id Optional Blank value allowed	Match calls handled by this Call Center. Must be a valid foreign key reference to an Call Center. Refer to: /api/docs/1.0/call_centers
inbound_webhook_id Optional Blank value allowed	Match records generated by this Inbound Webhook. Must be a valid foreign key reference to an Incoming Webhook. Refer to: /api/docs/1.0/inbound_webhooks
lead_import_id Optional Blank value allowed	Match leads imported from this Lead Import. Must be a valid foreign key reference to an Lead Import. Refer to: /api/docs/1.0/lead_imports
number_id Optional Blank value allowed	Match calls placed to this Number. Must be a valid foreign key reference to an Number. Refer to: /api/docs/1.0/phone_numbers
off_hook_buyer_id Optional Blank value allowed	Match calls off-hook to this Buyer. Must be a valid foreign key reference to an Buyer. Refer to: /api/docs/1.0/buyers
offer_id Optional Blank value allowed	Match records belonging to this Offer. Must be a valid foreign key reference to an Offer. Refer to: /api/docs/1.0/offers
provider_configuration_id Optional Blank value allowed	Match calls routed through this Provider Configuration. Must be a valid foreign key reference to an Provider. Refer to: /api/docs/1.0/provider_configurations
qa_buyer_id Optional Blank value allowed	Match calls where this Buyer was used for quality assurance monitoring. Must be a valid foreign key reference to an Buyer. Refer to: /api/docs/1.0/buyers
recent_call_disposition_id Optional Blank value allowed	Match leads whose most recent call has this Call Disposition. Must be a valid foreign key reference to an Call Disposition. Refer to: /api/docs/1.0/call_dispositions
referring_call_id Optional Blank value allowed	Match calls referred from this Call id. Must be a valid foreign key reference to an Call. Refer to: /api/docs/1.0/calls
referring_number_id Optional Blank value allowed	Match calls referred from this Number id. Must be a valid foreign key reference to an Number. Refer to: /api/docs/1.0/phone_numbers
referring_offer_id Optional Blank value allowed	Match calls referred from this Offer id. Must be an 8-bit integer ID or a 128-bit UUID reference to an object on Trackdrive. Example ID: 289302820, Example UUID: 924c37d5-e70f-42ad-84c2-e85eb0c1bc21
referring_schedule_id Optional Blank value allowed	Match calls referred from this Schedule id. Must be a valid foreign key reference to an Schedule. Refer to: /api/docs/1.0/schedules
ring_pool_id Optional Blank value allowed	Match calls placed through this Number Pool. Must be a valid foreign key reference to an Number Pool. Refer to: /api/docs/1.0/ring_pools
schedule_id Optional Blank value allowed	Match records belonging to this Schedule. Must be a valid foreign key reference to an Schedule. Refer to: /api/docs/1.0/schedules
sms_blast_id Optional Blank value allowed	Match records from this SMS Blast. Must be a valid foreign key reference to an Bulk SMS. Refer to: /api/docs/1.0/sms_blasts
token_id Optional Blank value allowed	Match records tagged with this Token. Must be a valid foreign key reference to an Token. Refer to: /api/docs/1.0/tokens
token_value_id Optional Blank value allowed	Match records tagged with this Token Value. Must be a valid foreign key reference to an Token Value. Refer to: /api/docs/1.0/token_values
traffic_source_id Optional Blank value allowed	Refer to the traffic source api for details Must be a valid foreign key reference to an Traffic Source. Refer to: /api/docs/1.0/traffic_sources
category Optional Blank value allowed	Group results by this field, when data_type is call (e.g. buyer_id, offer_id, status). Must be a String
code Optional Blank value allowed	Match records with this code. Must be a String
contact_field_type Optional Blank value allowed	Match records tagged with this Custom Contact Field Type. Must be a String
country Optional Blank value allowed	Match records from this country. Must be a String
creation_source Optional Blank value allowed	Match records created through this source. Must be a String
direction Optional Blank value allowed	Match calls with this direction (e.g. inbound or outbound). Must be a String
hangup_cause_status Optional Blank value allowed	Match calls with this hangup cause status. Must be a String
hangup_source Optional Blank value allowed	Match calls hung up by this source. Must be a String
hung_up_by Optional Blank value allowed	Match calls hung up by this party. Must be a String
off_hook_type Optional Blank value allowed	Match calls with this off-hook type. Must be a String
owner_type Optional Blank value allowed	Match leads owned by this type of record (Offer or Schedule). Must be a String
request_ip Optional Blank value allowed	Match records submitted from this IP address. Must be a String
request_method Optional Blank value allowed	Match records submitted with this HTTP method. Must be a String
schedule_ended_at_label Optional Blank value allowed	Only include leads whose schedule ended within this named timeframe. Must be a String
schedule_trigger_type Optional Blank value allowed	Match leads whose end of schedule trigger matches this type. Must be a String
state Optional Blank value allowed	Match records with this status value. Must be a String
state_province Optional Blank value allowed	Match records from this state or province. Must be a String
sub_id Optional Blank value allowed	Match records with this sub id. Must be a String
token_key Optional Blank value allowed	Calls that are tagged with this token will be matched. EG: token_key=buyer_id will return all calls that have a buyer_id token. Must be a String
token_value Optional Blank value allowed	Will match calls that are tagged with a token:value. EG: token_key=buyer_id:12345 will return all calls that have a buyer_id token with the value set to 12345. Must be a String
fulltext Optional Blank value allowed	Search for any record that matches this text Must be a String
last_call_at_from Optional Blank value allowed	Only include leads whose most recent call was on or after this time. Must be a String
last_call_at_to Optional Blank value allowed	Only include leads whose most recent call was on or before this time. Must be a String
optimizer_displayed_at_from Optional Blank value allowed	Only include leads whose optimizer results were displayed on or after this time. Must be a String
optimizer_tokens_changed_at_from Optional Blank value allowed	Only include leads whose optimizer tokens changed on or after this time. Must be a String
schedule_ended_at_from Optional Blank value allowed	Only include leads whose schedule ended on or after this time. Must be a String
schedule_ended_at_to Optional Blank value allowed	Only include leads whose schedule ended on or before this time. Must be a String

Example Request

curl -X POST 'https://[your-subdomain].trackdrive.com/api/v1/data_exports/' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "data_type": "contact",
  "name": "Example Contact Export",
  "created_at_from": "2026-01-15T13:30:00Z",
  "created_at_to": "2026-01-15T14:30:00Z",
  "column_names": [
    "number",
    "blocked",
    "sms_opt_out"
  ]
}'

Example Response 201

{
  "status": 201,
  "success": true,
  "errors": {},
  "data_export": {
    "id": 10001,
    "type": "DataExport",
    "uuid": null,
    "created_at": "2026-01-15T15:30:00.000Z",
    "updated_at": "2026-01-15T15:30:00.000Z",
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": "/data_exports/10001",
    "routes_edit_path": "/data_exports/10001/edit",
    "external_record_id": null,
    "company_id": 10002,
    "user_id": 10003,
    "data_type": "contact",
    "name": "Example Contact Export",
    "status": "queued",
    "created_at_from": "2026-01-15T13:30:00Z",
    "created_at_to": "2026-01-15T14:30:00Z",
    "started_at": null,
    "succeeded_at": null,
    "stopped_at": null,
    "total_count": null,
    "export_count": null,
    "export_file_url": null
  },
  "metadata": {
    "root": "data_export"
  }
}

Params

Must be any combination of:

Params