[Reports] Clicks (V5) - Affiliate

Ron Torres

Modified on: Fri, 18 Sep, 2015 at 6:08 PM

WSDL Page: http://<your_domain_here>/affiliates/api/5/reports.asmx?op=Clicks

Parameter Summary:

api_key / STRING = Affiliate API Key {See auth.asmx > Login}

affiliate_id / INT = Affiliate ID {See auth.asmx > Login}

start_date / DATETIME = Report Start Date [MM/DD/YYYY HH:MM:SS]

end_date / DATETIME = Report End Date [MM/DD/YYYY HH:MM:SS]

offer_id / INT = Offer ID ["0" = ALL Offers]

campaign_id / INT = Campaign ID ["0" = ALL Campaigns]

include_duplicates / BOOL = Include Duplicate Clicks? ["TRUE", "FALSE"]

start_at_row / INT = Starting Row Number [Usually "1", unless doing incremental API Calls]

row_limit / INT = Maximum Rows Returned ["0" = ALL Rows, "100000" = Maximum]

Parameter Types:

api_key - ID

affiliate_id - ID

start_date - ID

end_date - ID

offer_id - ID

campaign_id - ID

include_duplicates - ID

start_at_row - ID

row_limit - ID

Sample GET Call:

https://demo.cakemarketing.com/affiliates/api/5/reports.asmx/Clicks?api_key=s15Sl4xmfA&affiliate_id=2699&start_date=01/01/2013+00:00:00&end_date=07/01/2013+01:00:00&offer_id=0&campaign_id=0&include_duplicates=TRUE&start_at_row=1&row_limit=3

Sample XML Response:

<?xml version="1.0" encoding="UTF-8"?>
<click_response>
   <success>true</success>
   <row_count>1622</row_count>
   <clicks>
      <click>
         <click_date>2013-01-01T00:13:54.903</click_date>
         <offer>
            <offer_id>100</offer_id>
            <offer_name>AppTastic</offer_name>
         </offer>
         <redirect_from_offer>
            <offer_id>100</offer_id>
            <offer_name>AppTastic</offer_name>
         </redirect_from_offer>
         <campaign_id>997</campaign_id>
         <subid_1>CD2</subid_1>
         <subid_2 />
         <subid_3 />
         <subid_4 />
         <subid_5 />
         <ip_address>192.168.1.1</ip_address>
         <paid_action />
         <duplicate>false</duplicate>
         <duplicate_clicks>0</duplicate_clicks>
         <original_click_date />
      </click>
      <click>
         <click_date>2013-01-01T03:13:52.347</click_date>
         <offer>
            <offer_id>100</offer_id>
            <offer_name>AppTastic</offer_name>
         </offer>
         <redirect_from_offer>
            <offer_id>100</offer_id>
            <offer_name>AppTastic</offer_name>
         </redirect_from_offer>
         <campaign_id>997</campaign_id>
         <subid_1>CD2</subid_1>
         <subid_2 />
         <subid_3 />
         <subid_4 />
         <subid_5 />
         <ip_address>192.168.1.1</ip_address>
         <paid_action />
         <duplicate>false</duplicate>
         <duplicate_clicks>0</duplicate_clicks>
         <original_click_date />
      </click>
   </clicks>
</click_response>

Related Articles