MPZ API > List Links Clicked

Use the API to get a list of links that subscribers have clicked in a campaign.

Request

Submit an XML Request with the following details:
Post URL: https://mpzmail.com/api/v3.0/campaigns/listClicks/
Fields to Post
apiKey String REQUIRED The APIKey of the requesting user.
campaignID Int REQUIRED The ID of a campaign.
trackingType Int OPTIONAL Filters links by type (Only available for some clients). 0 is all links. 1 is links that trigger a create call.
fromDate DateTime OPTIONAL yyyy-mm-dd hh:mm:ss - The date you would like to start searching from.
toDate Datetime OPTIONAL The date time that you would like to retrieve stats to (format yyyy-mm-dd hh:mm:ss)

Response

Data Sent Back
error Int Indicates wether an error has occured. 0 for no error. 1 for error.
status String If there's been an error, a text description of the error that occured will be here.
linkCnt Int The number of links clicked
linksClicked    
----> linkClicked    
--------> subscriberID Int The subscriber ID
--------> firstName String The subscriber first name
--------> lastName String The subscriber last name
--------> email String The subscriber email address
--------> groupID Int The group ID the subscriber belongs to
--------> dateClicked Date Time The date and time of the click.
--------> urlClicked String The full URL of the link that was clicked.
--------> trackingType Int The type of link tracked. 0 is all links, 1 is links that trigger a create call for some clients.
--------> bindID Int The unique identifier of the action.
--------> customField1 String Any data in customField1.

Sample request XML

<xml>
     <apiKey>44-121312131223</apiKey>
     <campaignID>4124</campaignID>
</xml>

Sample response XML

<xml>
     <error>0</error>
     <status>success</status>
     <linkCnt>1</linkCnt>
     <linksClicked>
          <linkClicked>
               <subscriberID>1234</subscriberID>
               <firstName>Test</firstName>
               <lastName>User</lastName>
               <email>test@user.com</email>
               <groupID>1233</groupID>
               <dateClicked>2016-01-03 11:23</dateClicked>
               <urlClicked>http://samplewebsite.com</urlClicked>
               <trackingType>0</trackingType>
               <bindID>124124124</bindID>
               <customField1></customField1>
          </linkClicked>
     </linksClicked>
</xml>

Comments