« Back to Documentation OverviewcampaignEmailStatsAIM – v1.3
campaignEmailStatsAIM(string apikey, string cid, array email_address)
Given a campaign and email address, return the entire click and open history with timestamps, ordered by time
| Section | Campaign Report Data |
| Parameters | | apikey | a valid API Key for your user account. Get by visiting your API dashboard |
| cid | the campaign id to get stats for (can be gathered using campaigns()) |
| email_address | an array of up to 50 email addresses to check OR the email "id" returned from listMemberInfo, Webhooks, and Campaigns. For backwards compatibility, if a string is passed, it will be treated as an array with a single element (will not work with XML-RPC). |
| Returns | | array |
an array with the keys listed in Returned Fields below
| int | success | the number of email address records found
| | int | error | the number of email address records which could not be found
| | array | data | arrays containing the actions (opens and clicks) that the email took, with timestamps
| string | action | The action taken (open or click)
| | string | timestamp | Time the action occurred
| | string | url | For clicks, the URL that was clicked
| | |