reportGetSummary
public static array reportGetSummary (string token, string emailID)
Get the summary of an email campaign.
Section
Reports Related Methods

Parameters
string tokenA valid token for your account. To generate a token, use the login method.
string emailIDThe email campaign ID for which the summary statistics are to be fetched. To get the email campaign ID, use the reportGet method.

Returns
arrayReturns an array with the results.

Return Structure
string idThe email campaign ID
string emailNameThe name of the email campaign
string mailSentThe total number of emails sent
string opensThe total number of opens. To get the details, use the reportGetOpens method.
string clicksThe total number of clicks. To get the details, use the reportGetClicks method.
string bouncesThe total number of bounces. To get the details, use the reportGetBounces method.
string unsubscribesThe total number of unsubscribes. To get the details, use the reportGetUnsubscribes method.
string forwardsThe total number of forwards. To get the details, use the reportGetForwards method.
string abuseReportsThe total number of complaints received
integer toListIDThe target contact list ID
string toListNameThe target contact list name
string scheduleDateDate on which the campaign was sent.
string subjectSubject of the report
string shareURLShare Url for the report


Examples
download example code
xmlrpc_reportGetSummary.php


  1. <?php
  2. /**
  3. This Example shows how to authenticate a user using XML-RPC.
  4. Note that we are using the PEAR XML-RPC client and recommend others do as well.
  5. **/
  6. require_once 'XML/RPC2/Client.php';
  7. require_once 'inc/config.php';
  8. $client = XML_RPC2_Client::create($apiURL);
  9. $token = $client->login($apiLogin, $apiPassword);
  10.  
  11. /**
  12. Fetch the latest campaign, so we can retrieve the email campaign ID.
  13. **/
  14. $campaignList = $client->reportGet($token, "", 1, 1, "", "");
  15. $campaignID = $campaignList[0]['id'];
  16.  
  17. $summary = $client->reportGetSummary($token, $campaignID);
  18.  
  19. echo " Campaign: " . $summary['emailName'] . "(" . $summary['id'] . ") <br />";
  20. echo " To: " . $summary['toListName'] . "(" . $summary['toListID'] . ") <br />";
  21. echo " Date: " . $summary['scheduleDate'] . "<br />";
  22. echo " Total Sent: " . $summary['mailSent'] . "<br />";
  23. echo " Opens: " . $summary['opens'] . "<br />";
  24. echo " Bounces: " . $summary['bounces'] . "<br />";
  25. echo " Unsubscribes: " . $summary['unsubscribes'] . "<br />";
  26. echo " Clicks: " . $summary['clicks'] . "<br />";
  27. echo " Forwards: " . $summary['forwards'] . "<br />";
  28. echo " Abuse Complaint: " . $summary['abuseReports'] . "<br />";
  29.  
  30. ?>