Skip to main content
GET
/
export-campaign-data
Export campaign data
curl --request GET \
  --url https://www.tryunleashx.com/api/v1/global/export-campaign-data \
  --header 'token: <token>'
"<string>"
Use this endpoint to export campaign data as an Excel file (.xlsx) with optional filters.

​
Endpoint

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

​
Query Parameters

ParameterTypeRequiredDescription
agent_idnumber | arrayNoFilter by agent ID(s)
campaign_namestringNoPartial name search (LIKE)
campaign_statusstring | arrayNoFilter by status. Defaults to all except deleted.
date_rangestringNoDate range filter

​
Campaign Status Values

StatusDescription
draftCampaign is in draft mode
inprogressCampaign is actively running
holdCampaign is on hold
pauseCampaign is paused
force_completedCampaign was force completed

​
Response

Returns an Excel file (.xlsx) with the following columns:
ColumnDescription
IDCampaign identifier
Campaign NameName of the campaign
DescriptionCampaign description
Agent NameAssociated agent name
Start DateCampaign start date
End DateCampaign end date
StatusCampaign status label
Max RetryMaximum retry attempts
Max DelayDelay between retries
Total AudienceTotal audience count
Called AudienceNumber of audiences called
Created ByUser who created the campaign
Created DateCampaign creation date
Updated DateLast update date

​
Notes

  • The response is a binary Excel file stream, not JSON.
  • Set your HTTP client to handle binary/file responses.
  • If no campaign_status is provided, all statuses except deleted are included.
  • Date filter applies to CREATED_DATE of the campaign.

​
Example cURL

curl -X GET "https://www.tryunleashx.com/api/v1/global/export-campaign-data?campaign_status=inprogress&agent_id=5" \
  -H "token: <api_key>" \
  -o campaign_data.xlsx

Headers

​
token
string
required

API token for authentication

Query Parameters

​
agent_id
integer

Filter by agent ID

​
campaign_name
string

Partial name search (LIKE)

​
campaign_status
enum<string>

Filter by status. Valid values: draft, inprogress, hold, pause, force_completed. Defaults to all.

Available options:
draft,
inprogress,
hold,
pause,
force_completed
​
date_range
string

Date range filter

Response

Excel file download

The response is of type file.