function MCAPI::campaignOpenedAIM in Mailchimp 6.2

Same name and namespace in other branches

1. 5.2 MCAPI.class.php \MCAPI::campaignOpenedAIM()
2. 5 MCAPI.class.php \MCAPI::campaignOpenedAIM()
3. 6 MCAPI.class.php \MCAPI::campaignOpenedAIM()
4. 7 MCAPI.class.php \MCAPI::campaignOpenedAIM()

Retrieve the list of email addresses that opened a given campaign with how many times they opened - note: this AIM function is free and does not actually require the AIM module to be installed

AIM

@returnf string email Email address that opened the campaign @returnf integer open_count Total number of times the campaign was opened by this email address

Parameters

string $cid the campaign id to get opens for (can be gathered using campaigns()):

integer $start optional for large data sets, the page number to start at - defaults to 1st page of data (page 0):

integer $limit optional for large data sets, the number of results to return - defaults to 1000, upper limit set at 15000:

Return value

array Array of structs containing email addresses and open counts

File

./MCAPI.class.php, line 863

Class

MCAPI

Code

function campaignOpenedAIM($cid, $start = 0, $limit = 1000) {
  $params = array();
  $params["cid"] = $cid;
  $params["start"] = $start;
  $params["limit"] = $limit;
  return $this
    ->callServer("campaignOpenedAIM", $params);
}