Skip to main content
GET
Export campaign audience data
Use this endpoint to export campaign audience data as an Excel file (.xlsx) with optional filters.

Endpoint

GET /export-campaign-audience-data Authentication: Required (workspace auth)

Query Parameters

Audience Status Values

Response

Returns an Excel file (.xlsx) with the following columns:

Notes

  • The response is a binary Excel file stream, not JSON.
  • Set your HTTP client to handle binary/file responses.
  • Dynamic columns are derived from the agent’s metadata input configuration.
  • The campaign_id must belong to the authenticated company and workspace.
  • Date filter applies to CREATED_DATE of the audience record.

Example cURL

Headers

token
string
required

API token for authentication

Query Parameters

campaign_id
integer
required

Campaign identifier

mobile_no
string

Partial mobile number search

status
enum<string>

Filter by audience status. Valid values: fresh, completed, halted, inqueue

Available options:
fresh,
completed,
halted,
inqueue
call_status
string

Filter by call status

first_status
string

Filter by first call status

last_status
string

Filter by last call status

attempt
integer

Filter by attempt count

date_range
string

Date range filter

Response

Excel file download

The response is of type file.