Example Usage of

Obtain all totals for a specific campaign.

Description: Obtain all totals for a specific campaign, including links, forwards, opens, bounces, etc. This only provides the total amount. To view specific data, use the campaign_report_DATA_list API methods. To view data in a certain date range, you must supply both the sdate and ldate parameters.
Endpoint: /admin/api.php?api_action=campaign_report_totals
HTTP method: GET
Supported output formats: xml, json, serialize
Requires authentication: true
* indicates requirement. Underlined params include in URL, otherwise as part of the post body. POST data must be formatted as
Content-Type: application/x-www-form-urlencoded
. We don't accept any other input formats like JSON.
Variable Description
api_key*Your API key
api_outputxml, json, or serialize (default is XML)
campaignid*ID of the campaign you wish to see totals for
messageidMessage ID (optional)
sdateBeginning of date range NOTE: sdate and ldate must both be in ISO-8601 format
ldateEnd of date range
Example response:
Variable Description
typeCampaign type
ldate2011-03-07 11:41:18
statusCurrent status of the campaign. Example: 5
total_amtTotal contacts sent this campaign. Example: 4
send_amtTotal amount sent. Example: 4
messageidThe message ID used for this campaign
uniqueopensTotal number of unique opens for this campaign. Example: 1
uniquelinkclicksTotal number of unique link clicks for this campaign. Example: 4
uniquerepliesTotal number of unique replies to this campaign. Example: 4
subscriberclicksTotal contact clicks for links in this campaign. Example: 1
unsubscribesTotal unsubscribes for this campaign. Example: 0
uniqueforwardsTotal number of unique forwards for this campaign. Example: 4
forwardsTotal forwards for this campaign. Example: 0
updatesTotal updates for this campaign. Example: 0
totalbouncesTotal bounces for this campaign. Example: 3
socialsharesTotal social shares for this campaign. Example: 1
ldate_isotimestamp for testing purposes
revenueAll aggregate revenue for this campaign
revenue_trackedWhether or not revenue was tracked for this campaign.
ecomReportingEnabledWhether or not revenue was reported for this campaign.
hasEcomIntegrationWhether or not this campaign has at least one ecommerce integration connected
result_codeWhether or not the response was successful. Examples: 1 = yes, 0 = no
result_messageA custom message that appears explaining what happened. Example: Something is returned
result_outputThe result output used. Example: serialize

PHP Example

This is an example of using the campaign_report_totals call with PHP. You can replicate the same idea in virtually any other programming language. The example shown is using serialize as the output format. You can change that to XML or JSON if you would like.


// By default, this sample code is designed to get the result from your ActiveCampaign installation and print out the result
$url = '';

$params = array(

	// the API Key can be found on the "Settings" page in the "Developer" section under "API Access" -> "Key".
	// replace this with your API Key
	'api_key'      	=> 'YOUR_API_KEY',

	// this is the action that fetches info based on the parameters you provide
	'api_action'   	=> 'campaign_report_totals',

	// define the type of output you wish to get back
	// possible values:
	// - 'xml'  :      you have to write your own XML parser
	// - 'json' :      data is returned in JSON format and can be decoded with
	//                 json_decode() function (included in PHP since 5.2.0)
	// - 'serialize' : data is returned in a serialized format and can be decoded with
	//                 a native unserialize() function
	'api_output'   	=> 'serialize',

	// IDs you wish to fetch
	'campaignid'	=> '122',
	'messageid'  	=> '3',

// This section takes the input fields and converts them to the proper format
$query = "";
foreach( $params as $key => $value ) $query .= urlencode($key) . '=' . urlencode($value) . '&';
$query = rtrim($query, '& ');

// clean up the url
$url = rtrim($url, '/ ');

// This sample code uses the CURL library for php to establish a connection,
// submit your request, and show (print out) the response.
if ( !function_exists('curl_init') ) die('CURL not supported. (introduced in PHP 4.0.2)');

// If JSON is used, check if json_decode is present (PHP 5.2.0+)
if ( $params['api_output'] == 'json' && !function_exists('json_decode') ) {
	die('JSON not supported. (introduced in PHP 5.2.0)');

// define a final API request - GET
$api = $url . '/admin/api.php?' . $query;

$request = curl_init($api); // initiate curl object
curl_setopt($request, CURLOPT_HEADER, 0); // set to 0 to eliminate header info from response
curl_setopt($request, CURLOPT_RETURNTRANSFER, 1); // Returns response data instead of TRUE(1)
//curl_setopt($request, CURLOPT_SSL_VERIFYPEER, FALSE); // uncomment if you get no gateway response and are using HTTPS
curl_setopt($request, CURLOPT_FOLLOWLOCATION, true);

$response = (string)curl_exec($request); // execute curl fetch and store results in $response

// additional options may be required depending upon your server configuration
// you can find documentation on curl options at
curl_close($request); // close curl object

if ( !$response ) {
	die('Nothing was returned. Do you have a connection to Email Marketing server?');

// This line takes the response and breaks it into an array using:
// JSON decoder
//$result = json_decode($response);
// unserializer
$result = unserialize($response);
// XML parser...
// ...

// Result info that is always returned
echo 'Result: ' . ( $result['result_code'] ? 'SUCCESS' : 'FAILED' ) . '<br />';
echo 'Message: ' . $result['result_message'] . '<br />';

// The entire result printed out
echo 'The entire result printed out:<br />';
echo '<pre>';
echo '</pre>';

// Raw response printed out
echo 'Raw response printed out:<br />';
echo '<pre>';
echo '</pre>';

// API URL that returned the result
echo 'API URL that returned the result:<br />';
echo $api;?>

Questions? Discuss this API call in our developer forum