campaignStats – v1.3

 campaignStats(string apikey, string cid)

Given a list and a campaign, get all the relevant campaign statistics (opens, bounces, clicks, etc.)

Section
Campaign Stats

Parameters
apikey	a valid API Key for your user account. Get by visiting your API dashboard
cid	the campaign id to pull stats for (can be gathered using campaigns())

Returns

array

struct of the statistics for this campaign int syntax_errors Number of email addresses in campaign that had syntactical errors. int hard_bounces Number of email addresses in campaign that hard bounced. int soft_bounces Number of email addresses in campaign that soft bounced. int unsubscribes Number of email addresses in campaign that unsubscribed. int abuse_reports Number of email addresses in campaign that reported campaign for abuse. int forwards Number of times email was forwarded to a friend. int forwards_opens Number of times a forwarded email was opened. int opens Number of times the campaign was opened. string last_open Date of the last time the email was opened. int unique_opens Number of people who opened the campaign. int clicks Number of times a link in the campaign was clicked. int unique_clicks Number of unique recipient/click pairs for the campaign. string last_click Date of the last time a link in the email was clicked. int users_who_clicked Number of unique recipients who clicked on a link in the campaign. int emails_sent Number of email addresses campaign was sent to. int unique_likes total number of unique likes (Facebook) int recipient_likes total number of recipients who liked (Facebook) the campaign int facebook_likes total number of likes (Facebook) that came from Facebook array absplit If this was an absplit campaign, stats for the A and B groups will be returned int bounces_a bounces for the A group int bounces_b bounces for the B group int forwards_a forwards for the A group int forwards_b forwards for the B group int abuse_reports_a abuse reports for the A group int abuse_reports_b abuse reports for the B group int unsubs_a unsubs for the A group int unsubs_b unsubs for the B group int recipients_click_a clicks for the A group int recipients_click_b clicks for the B group int forwards_opens_a opened forwards for the A group int forwards_opens_b opened forwards for the A group array timewarp If this campaign was a Timewarp campaign, an array of stats from each timezone for it, with the GMT offset as they key. Each timezone will contain: int opens opens for this timezone string last_open the date/time of the last open for this timezone int unique_opens the unique opens for this timezone int clicks the total clicks for this timezone string last_click the date/time of the last click for this timezone int unique_opens the unique clicks for this timezone int bounces the total bounces for this timezone int total the total number of members sent to in this timezone int sent the total number of members delivered to in this timezone array timeseries For the first 24 hours of the campaign, per-hour stats: string timestamp The timestemp in Y-m-d H:00:00 format int emails_sent the total emails sent during the hour int unique_opens unique opens seen during the hour int recipients_click unique clicks seen during the hour

Examples (2)

download example code

[1] mcapi_campaignStats.php

<?php
/**
This Example shows how to pull basic stats for a Campaign Tests 
via the MCAPI class.
**/
require_once 'inc/MCAPI.class.php';
require_once 'inc/config.inc.php'; //contains apikey
 
$api = new MCAPI($apikey);
 
$retval = $api->campaignStats($campaignId);
 
if ($api->errorCode){
	echo "Unable to Load Campaign Stats!";
	echo "\n\tCode=".$api->errorCode;
	echo "\n\tMsg=".$api->errorMessage."\n";
} else {
    echo "Stats for ".$campaignId."\n";
    foreach($retval as $k=>$v){
        echo "\t".$k." => ".$v."\n";
    }
}
 
?>
 

[2] xml-rpc_campaignStats.php

<?php
/**
This Example shows how to using XML-RPC to grab the Stats for a Campaign you
previously sent
Note that we are using the PEAR XML-RPC client and recommend others do as well.
**/
require_once 'XML/RPC2/Client.php';
require_once 'inc/config.inc.php';
try {
    $client = XML_RPC2_Client::create($apiUrl);
 
	$result = $client->campaignStats($apikey, $campaignId);
 
	echo "SUCCESS! \n";
	echo "Stats for ".$campaignId."\n";
	foreach($result as $k=>$v){
	    echo "\t".$k." => ".$v."\n";
	}
} catch (XML_RPC2_FaultException $e){
	echo "ERROR!!!!\n";
	echo $e->getFaultCode()." : ".$e->getFaultString()."\n";
}
echo "\n";
 
?>