Service: GetTrackingLinkHits

The GetTrackingLinkHits service allows you to recall all email addresses that clicked on a specified tracking link.

Service Details

SOAP Action: GetTrackingLinkHits
SOAP Return Object: GetTrackingLinkHitsResp

Input

The following table describes the parameters used for calling the GetTrackingLinkHits service.

Table: instance of GetTrackingLinkHitsReq

Parameter Mandatory Type Description
header Y APIRequestHeader Header for authentication
trackingLinkId Y Integer Tracking link id

Output

The following table describes the parameters returned from the GetTrackingLinkHits service.

Table: instance of GetTrackingLinkHitsResp

Parameter Mandatory Type Description
header / APIResponseHeader Header containing authentication information
errorCode / Integer Numerical value of the error
errorMessage / String Short literal description of the error
trackingLinkHitTypeItems / Array of TrackingLinkHitType Array of trackingLinkHitType items

Table: response codes of GetTrackingLinkHitsResp.

0 No error
220 Authentication error, see header object for detailed information
221 Invalid tracking link id

Example

This examples show the request of all clicks for tracking link with id 99.

<?php
$header->userId = USER_ID;
$header->userToken = USER_TOKEN;

$getTrackingLinkHitsReq->header = $header;
$getTrackingLinkHitsReq->trackingLinkId= 222;

$getTrackingLinkHitsResp = $SoapClient->__soapCall("GetTrackingLinkHits", array($getTrackingLinkHitssReq));

if ($getTrackingLinkHitsResp->ErrorCode == 0) {
	// Handle return list of unsubscriptions.
} else {
	echo "Tracking link hits could not be retrieved: " . $getTrackingLinkHitsResp->errorMessage;
}
?>