Export Campaign Data

Export campaign data

curl --request GET \
  --url https://www.tryunleashx.com/api/v1/global/export-campaign-data \
  --header 'token: <token>'

const options = {method: 'GET', headers: {token: '<token>'}};

fetch('https://www.tryunleashx.com/api/v1/global/export-campaign-data', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://www.tryunleashx.com/api/v1/global/export-campaign-data",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "token: <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://www.tryunleashx.com/api/v1/global/export-campaign-data"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("token", "<token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://www.tryunleashx.com/api/v1/global/export-campaign-data")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["token"] = '<token>'

response = http.request(request)
puts response.read_body

"<string>"

GET

export-campaign-data

Export campaign data

curl --request GET \
  --url https://www.tryunleashx.com/api/v1/global/export-campaign-data \
  --header 'token: <token>'

const options = {method: 'GET', headers: {token: '<token>'}};

fetch('https://www.tryunleashx.com/api/v1/global/export-campaign-data', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://www.tryunleashx.com/api/v1/global/export-campaign-data",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "token: <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://www.tryunleashx.com/api/v1/global/export-campaign-data"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("token", "<token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://www.tryunleashx.com/api/v1/global/export-campaign-data")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["token"] = '<token>'

response = http.request(request)
puts response.read_body

"<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

Parameter	Type	Required	Description
`agent_id`	number \| array	No	Filter by agent ID(s)
`campaign_name`	string	No	Partial name search (LIKE)
`campaign_status`	string \| array	No	Filter by status. Defaults to all except `deleted`.
`date_range`	string	No	Date range filter

Campaign Status Values

Status	Description
`draft`	Campaign is in draft mode
`inprogress`	Campaign is actively running
`hold`	Campaign is on hold
`pause`	Campaign is paused
`force_completed`	Campaign was force completed

Response

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

Column	Description
ID	Campaign identifier
Campaign Name	Name of the campaign
Description	Campaign description
Agent Name	Associated agent name
Start Date	Campaign start date
End Date	Campaign end date
Status	Campaign status label
Max Retry	Maximum retry attempts
Max Delay	Delay between retries
Total Audience	Total audience count
Called Audience	Number of audiences called
Created By	User who created the campaign
Created Date	Campaign creation date
Updated Date	Last 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.

API Documentation

Phone Numbers

Voice AI

Click to Call

Call Logs

Campaigns

Workspaces

Users

Export Campaign Data

Endpoint

Query Parameters

Campaign Status Values

Response

Notes

Example cURL

Headers

Query Parameters

Response

​Endpoint

​Query Parameters

​Campaign Status Values

​Response

​Notes

​Example cURL

Headers

Query Parameters

Response

Endpoint

Query Parameters

Campaign Status Values

Response

Notes

Example cURL