POST GET emailReports/clicks

Get link click data per contact for a given email

* required

Parameters

Name	Type	Description
emailID *	integer	ID of email
link	string	Filter by specific link
page	integer	Number of page in results to return Default: 1 Min: 1
rpp	integer	Number of records to return per page Default: 20 Min: 1 Max: 1000
sortField	string	The field to sort results by Default: date Allowed Values: contactID, email, date
sortDirection	string	The direction to sort results Default: asc Allowed Values: asc, desc

Response Data

Name	Type	Description
contactID	integer	ID of contact
email	string	Email address of contact
link	string	Link that was clicked
ipAddress	string	IP address of contact
date	datetime	Timestamp of activity
emailID	integer	Unique ID of email
parentEmailID	integer	ID of parent email record

Example Calls

All clicks

GET

/emailReports/clicks?emailID=123

cURL

Copy

curl https://api.emailer.emfluence.com/v1/emailReports/clicks?emailID=123 \
	-H "Authorization: Bearer {{accessToken}}"

Response Data

{"success":1,"data":{"paging":{"next":"","page":1,"rpp":3,"totalPages":1,"totalRecords":3,"prev":""},"records":[{"emailID":123,"parentEmailID":"","contactID":123,"link":"http://www.example.com","date":"2013-10-03 20:48:46","ipAddress":"64.233.172.73","email":"jane.doe@example.com"},{"emailID":123,"parentEmailID":"","contactID":456,"link":"http://emailer.emfluence.com/f2f","date":"2013-10-03 20:49:20","ipAddress":"204.116.238.83","email":"john.doe@example.com"},{"emailID":123,"parentEmailID":"","contactID":456,"link":"http://www.example.com","date":"2013-10-03 20:49:25","ipAddress":"204.116.238.83","email":"john.doe@example.com"}]},"code":0,"requestID":"D26246AE-A380-419C-977AF1907B74A776"}

Clicks for a given link

GET

/emailReports/clicks?emailID=123&link=http%3A%2F%2Fwww.example.com

cURL

Copy

curl https://api.emailer.emfluence.com/v1/emailReports/clicks?emailID=123&link=http%3A%2F%2Fwww.example.com \
	-H "Authorization: Bearer {{accessToken}}"

Response Data

{"success":1,"data":{"paging":{"next":"","page":1,"rpp":2,"totalPages":1,"totalRecords":2,"prev":""},"records":[{"emailID":123,"parentEmailID":"","contactID":123,"link":"http://www.example.com","date":"2013-10-03 20:48:46","email":"jane.doe@example.com"},{"emailID":123,"parentEmailID":"","contactID":456,"link":"http://www.example.com","date":"2013-10-03 20:49:25","email":"john.doe@example.com"}]},"code":0,"requestID":"C82D1FE7-A652-4562-BA048DA1CCB30F9C"}

API Console

The console uses production data, so BE CAREFUL!

GET

emailReports/clicks

Param	Type	Description
emailID *	integer	ID of email
link	string	Filter by specific link
page	integer	Number of page in results to return Default: 1 Min: 1
rpp	integer	Number of records to return per page Default: 20 Min: 1 Max: 1000
sortField	string	The field to sort results by Default: date Allowed Values: contactID, email, date
sortDirection	string	The direction to sort results Default: asc Allowed Values: asc, desc

Access token: *

Email Reports

POST GET emailReports/clicks

Parameters

Response Data

Example Calls

All clicks

Clicks for a given link

API Console