function MCAPI::campaignClickDetailAIM in Mailchimp 5

Same name and namespace in other branches

1. 5.2 MCAPI.class.php \MCAPI::campaignClickDetailAIM()
2. 6.2 MCAPI.class.php \MCAPI::campaignClickDetailAIM()
3. 6 MCAPI.class.php \MCAPI::campaignClickDetailAIM()
4. 7 MCAPI.class.php \MCAPI::campaignClickDetailAIM()

Return the list of email addresses that clicked on a given url, and how many times they clicked

AIM

@returnf string email Email address that opened the campaign @returnf integer clicks Total number of times the URL was clicked on by this email address

Parameters

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

string $url the URL of the link that was clicked on:

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 click counts

File

./MCAPI.class.php, line 527

Class

MCAPI

Code

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