« Back to Documentation Overview

campaignClickDetailAIM – v1.1

 campaignClickDetailAIM(string apikey, string cid, string url, integer start, integer limit)

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

Section
Campaign AIM
Parameters
apikey a valid API Key for your user account. Get by calling Get by visiting your API dashboard
cid the campaign id to get click stats for (can be gathered using campaigns())
url the URL of the link that was clicked on
start optional - for large data sets, the page number to start at - defaults to 1st page of data (page 0)
limit optional - for large data sets, the number of results to return - defaults to 1000, upper limit set at 15000
Returns
array Array of structs containing email addresses and click counts
Returned Fields
stringemailEmail address that opened the campaign
integerclicksTotal number of times the URL was clicked on by this email address