Click Listing API

Must use a GET method to run the Click Listing API.  The click data is the same data that is in the Click Listing report except for the API is only for CPA, CPL and Leadgen clicks.  CPC clicks are considered to be conversions and can be pulled using the transaction details API.  The date range must be within the same month or you will receive an error message.  The results will display 5000 clicks at a time.and will contain a "Next Row ID" which you will add as the startid for your next call.  

You are able to pull clicks in XML or JSON format by including the following headers.

  • Accept:application/xml for an xml response
  • Accept:application/json for a json response

Base URL 

https://api.linktrust.com/v2/reports/clicklisting

Parameters

StartId - This is the Next Row ID value that is returned when the API is run for more than 5000 records. It is used to retrieve the next set of clicks.

StartDate - Required. This is the starting date that you wish to run the API.  Must be a valid date within the same month. Cannot be after the EndDate.

EndDate- Required. This is the ending date that you wish to run the API.  Must be a valid date within the same month. Cannot be before the StartDate.

CampaignId - A valid Campaign ID from your account.

AffiliateId - A valid Affiliate ID from your account.

Example URL

https://api.linktrust.com/v2/reports/clicklisting?startid=123456&StartDate=12/7/2015&EndDate=12/7/2015&CampaignId=123456&AffiliateId=123456

Example XML Response

<z:anyType i:type="ClickListingReport"
  <Clicks> 
   <ClickListingReport>
    <AdditionalData><Data /></AdditionalData>
    <AffiliateId>100000</AffiliateId>
    <AffiliateReferenceId />
    <CampaignId>100260</CampaignId>
    <ClickDateTime>2015-12-07T15:23:29.82</ClickDateTime>
    <ClickId>12_35463_abf02835-0b67-4109-9b24-43fd0184bb24</ClickId>
    <CountryCode>US</CountryCode>
    <CreativeId>104790</CreativeId>
    <FromCampaignId>0</FromCampaignId>
    <IPAddress>66.102.8.147</IPAddress>
    <MerchantId>100010</MerchantId>
    <Referrer>http://www.google.co.jp/url?     sa=t&rct=j&q=&esrc=s&source=web&cd=1&ved=0CDEQFjAD&url=http%3A%2F%2Fgoo.gl%2FwcWAO5&ei=4QZmVqvtCbqc2wP7Kw&usg=AFQjCNGWONHG1bT2RdlLG-KIcXLdhhggLw</Referrer>
    <SubId />
    <UserAgent>Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/40.0.2214.91 Safari/537.36</UserAgent>
   </ClickListingReport>
   <ClickListingReport>
    <AdditionalData><Data /></AdditionalData>
    <AffiliateId>100000</AffiliateId>
    <AffiliateReferenceId />
    <CampaignId>100260</CampaignId>
    <ClickDateTime>2015-12-07T15:24:45.393</ClickDateTime>
    <ClickId>12_35469_c7d8d463-25ed-40ce-a341-11e878324fba</ClickId>
    <CountryCode>US</CountryCode>
    <CreativeId>104790</CreativeId>
    <FromCampaignId>0</FromCampaignId>
    <IPAddress>66.249.92.17</IPAddress>
    <MerchantId>100010</MerchantId>
    <Referrer />
    <SubId />
    <UserAgent>Mozilla/5.0 (Macintosh; Intel Mac OS X 10_8_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/28.0.1500.71 Safari/537.36</UserAgent>
   </ClickListingReport>
  </Clicks>
 <IsMoreAvailable>false</IsMoreAvailable>
 <NextRowId>0</NextRowId>
</z:anyType>

Example JSON Response

{"Clicks":[
     {
       "CampaignId":100260,
       "AffiliateId":100000,
       "CreativeId":104790,
       "SubId":"",
       "AffiliateReferenceId":"",
       "ClickDateTime":"2015-12-07T15:23:29.82",
       "UserAgent":"Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/40.0.2214.91 Safari/537.36",
       "Referrer":"http://www.google.co.jp/url?sa=t&rct=j&q=&esrc=s&source=web&cd=1&ved=0CDEQFjAD&url=http%3A%2F%2Fgoo.gl%2FwcWAO5&ei=4QZmVqvtCbqc2wP7Kw&usg=AFQjCNGWONHG1bT2RdlLG-KIcXLdhhggLw",
       "IPAddress":"66.102.8.147",
       "MerchantId":100010,
       "CountryCode":"US",
       "AdditionalData":"<Data />",
       "FromCampaignId":0,
       "ClickId":"12_35463_abf02835-0b67-4109-9b24-43fd0184bb24"
     },
     {
       "CampaignId":100260,
       "AffiliateId":100000,
       "CreativeId":104790,
       "SubId":"",
       "AffiliateReferenceId":"",
       "ClickDateTime":"2015-12-07T15:24:45.393",
       "UserAgent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_8_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/28.0.1500.71 Safari/537.36",
       "Referrer":"",
       "IPAddress":"66.249.92.17",
       "MerchantId":100010,
       "CountryCode":"US",
       "AdditionalData":"<Data />",
       "FromCampaignId":0,
       "ClickId":"12_35469_c7d8d463-25ed-40ce-a341-11e878324fba"
     }],
"IsMoreAvailable":false,
"NextRowId":0}
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.