FRfreyavoice
Export

Request export

Requests a data export from one of the supported endpoints. The export can be delivered as a direct download URL or sent via email.

Supported Endpoints:

  • /api/v2/call - Export calls
  • /api/v2/campaign - Export campaigns
  • /api/v2/phone-numbers - Export phone numbers
  • /api/v2/solutions/runs - Export solution runs
  • /api/v2/problems - Export feedback/problems

Export Formats:

  • csv - Comma-separated values
  • xlsx - Excel spreadsheet
  • markdown - Markdown table
  • json - JSON array

The params object should include the same query parameters you would use when calling the endpoint directly, including workspaceId.

post/export

Request

  • Base URL
    https://app.freyavoice.ai/api/v2
  • Auth
    HTTP bearer

Request body

endpoint'/api/v2/call' | '/api/v2/campaign' | '/api/v2/phone-numbers' | '/api/v2/solutions/runs' | '/api/v2/problems' required

API endpoint to export data from

paramsobject required

Query parameters to pass to the endpoint (must include workspaceId)

format'csv' | 'xlsx' | 'markdown' | 'json'

Export file format

deliveryMethod'download' | 'email'

How to deliver the export

emailstring email nullable

Email address for email delivery

Response

Export ready or email sent

successtrue required

Changes

No recorded changes to this operation across all 1 revision of this API.