Back to Documentation Overview

campaignAbuseReports

public static campaignAbuseReports(string apikey, string cid, string since, integer start, integer limit)

Get all email addresses that complained about a given campaign

Section:
Campaign Stats
Parameters:
apikey a valid API Key for your user account. Get by calling login()
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
Returned Fields:
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

  1. <?php
  2. /**
  3. This Example shows how to add grab a full set of Campaign Abuse Reports wtih
  4. some basic error checking.
  5. **/
  6. require_once 'inc/MCAPI.class.php';
  7. require_once 'inc/config.inc.php'; //contains apikey
  8.  
  9. // Connect to the MailChimp api with an API Key
  10. $api = new MCAPI($apikey);
  11.  
  12. $reports = $api->campaignAbuseReports($campaignId);
  13.  
  14. if ($api->errorCode){
  15. echo "Unable to run campaignAbuseReports()!\n";
  16. echo "\tCode=".$api->errorCode."\n";
  17. echo "\tMsg=".$api->errorMessage."\n";
  18. } else {
  19. foreach($reports as $rpt){
  20. echo $rpt['date']." - ".$rpt['email']." - ".$rpt['type']."\n";
  21. }
  22. }
  23.  
  24. ?>
  25.  
Add New Note User Contributed Notes for campaignAbuseReports
No notes, yet... Will you be the first??