campaignAbuseReports – v1.3

 campaignAbuseReports(string apikey, string cid, string since, int start, int limit)

Get all email addresses that complained about a given campaign

Section
Campaign Stats

mcapi_campaignAbuseReports.php

Parameters
apikey	a valid API Key for your user account. Get by visiting your API dashboard
cid	the campaign id to pull abuse reports for (can be gathered using campaigns())
start	optional - for large data sets, the page number to start at - defaults to 1st page of data (page 0)
limit	optional - for large data sets, the number of results to return - defaults to 500, upper limit set at 1000
since	optional - pull only messages since this time - use YYYY-MM-DD HH:II:SS format in GMT

Returns
array	reports the abuse reports for this campaign int total the total reports matched array data the report data for each, including: string date date/time the abuse report was received and processed string email the email address that reported abuse string type an internal type generally specifying the orginating mail provider - may not be useful outside of filling report views

Examples (1)

download example code

[1] mcapi_campaignAbuseReports.php

<?php
/**
This Example shows how to add grab a full set of Campaign Abuse Reports wtih 
some basic error checking.
**/
require_once 'inc/MCAPI.class.php';
require_once 'inc/config.inc.php'; //contains apikey
 
// Connect to the MailChimp api with an API Key
$api = new MCAPI($apikey);
 
$reports = $api->campaignAbuseReports($campaignId);
 
if ($api->errorCode){
	echo "Unable to run campaignAbuseReports()!\n";
	echo "\tCode=".$api->errorCode."\n";
	echo "\tMsg=".$api->errorMessage."\n";
} else {
	echo "Total reports:".$reports['total']."\n";
	echo "Reports returned:".sizeof($reports['data'])."\n";
	foreach ($reports['data'] as $rpt){
        echo $rpt['date']." - ".$rpt['email']." - ".$rpt['type']."\n";
    }
}
 
?>