function MCAPI::campaignEmailStatsAIMAll in Mailchimp 6.2

Same name and namespace in other branches

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

Given a campaign and correct paging limits, return the entire click and open history with timestamps, ordered by time, for every user a campaign was delivered to.

AIM

@example mcapi_campaignEmailStatsAIMAll.php

@returnf string action The action taken (open or click) @returnf date timestamp Time the action occurred @returnf string url For clicks, the URL that was clicked

Parameters

string $cid the campaign id to get stats 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 100, upper limit set at 1000:

Return value

array Array of structs containing actions (opens and clicks) for each email, with timestamps

File

./MCAPI.class.php, line 945

Class

MCAPI

Code

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