Guides

Export data

View as Markdown

Exports produce CSV files using the same column selection and flattening as dashboard downloads. Create a job, poll its status, and use download_url when it is completed.

1

Create

Send POST /exports with resource and filters. Receive 202 and the export ID.
2

Check progress

Call GET /exports/{export_id} until status is completed or failed.
3

Download CSV

Open the returned download_url before download_expires_at. Retrieve the job again for a fresh link while the file is available.

Input

FieldRequiredContract
resourceYesconversations, customers, or voice_conversations.
filtersYesSame resource, date and dashboard-filter meaning as list retrieval.
filters.time_fieldNoconversation_time for conversations and Voice Agents; last_interaction_at for customers. Defaults to the resource’s field.
filters.start_time, filters.end_timeYesInteger epoch seconds; start inclusive, end exclusive; at most 31 days.
filters.service_idFor analyticsRequired for conversations and customers. Voice Agent exports use optional agent_id.
filters.filterNoSame optional dashboard filter object documented on the corresponding list API.
formatNocsv only; defaults to csv.
parametersNoDashboard download sections to include. Defaults to all supported sections; must include Meta Data for analytics or Metadata for Voice Agents. Allowed labels are listed in the API reference.

CSV contents

ResourceExisting download sections
ConversationsMetadata, summary, Agent Feedback, Business Insights, dispositions, concerns/queries, Lead Quality, templates, Custom Module, explanations, subparameters and transcription.
CustomersMetadata, summary, Business Insights, dispositions, concerns/queries, Lead Quality, templates, Custom Module, timeline, explanations and subparameters.
Voice Agent conversationsMetadata, transcription, scheduling, CRM payload, request data, tool calls, subparameters, summary, Business Insights and explanations.

The CSV uses the dashboard’s existing column names and handling of nested values. Columns depend on the chosen sections and configured analytics. Transcription text is included when Transcript is selected (the default includes it). Recording audio is not embedded in a CSV file.

Output

The API returns a JSON job object in data; it does not embed the CSV content.

FieldFormat
id, resource, formatExport ID, selected resource, and csv.
statusqueued, processing, completed, failed, or expired.
created_at, completed_atEpoch seconds; completed_at is null while queued or processing and is set when processing finishes, including failure.
download_urlTemporary signed CSV link when completed; otherwise null.
download_expires_atLink expiry in epoch seconds, or null.
errorError code/message when failed; otherwise null.

Limits

ControlLimit
Date window31 days per job. Older stored data can be requested.
File sizeUp to 100,000 records and 100 MB. Narrow the filters or date range if the job is too large.
Active jobsFive per key.
File availabilitySeven days after completion.
Link lifetimeAt most ten minutes; retrieve the job for a fresh link.

Use adjacent windows for longer periods: the previous end_time becomes the next start_time. Only the key that created the job can retrieve it. Expired, deleted or rotated keys cannot start downloads or obtain fresh links. Retain the returned job ID and poll it; submitting another request creates another job.