reportGetClickEmails
public static array reportGetClickEmails (string token, string emailID,string clickURL, integer pageNumber, integer pageSize, string orderBy, string sortOrder)
Get the Emails of the receipients clicking on URLs for a campaign ,using the paging limits.
Parameters
|
string token | A valid token for your account. To generate a token, use the login method. |
string emailID | The email campaign ID for which the click emails are to be fetched. To get the email campaign ID, use the reportGet method. |
string clickUrl | The url on which the user clicks in the email |
integer pageNumber | Fetch results from the given page number. |
integer pageSize | Number of results per page. |
string orderBy | Sort the results based on "email" or "date". |
string sortOrder | Sort the results in the "asc"ending or "desc"ending order. |
Returns |
array | Returns an array with the results. |
Return Structure |
integer sequence | The sequence number of the record |
string email | The opened email address |
string name | Name of the contact |
string logdate | Date on which the click was logged. |
- <?php
- /**
- This Example shows how to authenticate a user using XML-RPC.
- Note that we are using the PEAR XML-RPC client and recommend others do as well.
- **/
- require_once 'XML/RPC2/Client.php';
- require_once 'inc/config.php';
- $client = XML_RPC2_Client::create($apiURL);
- $token = $client->login($apiLogin, $apiPassword);
-
- /**
- Fetch the latest campaign, so we can retrieve the email campaign ID.
- **/
- $campaignList = $client->reportGet($token, "", 1, 1, "", "");
- $campaignID = $campaignList[0]['id'];
-
- $clickUrl="";
- $openList = $client->reportGetClickEmails($token, $campaignID,$clickUrl, 1, 100, "", "");
-
- foreach($openList as $rec){
- echo $rec['sequence'] . "] Email: " . $rec['email'];
- echo " Name: " . $rec['name'];
- echo " Date: " . $rec['logdate'] . "<br />";
- }
-
- ?>