DEPRECATED - [Reports] Clicks (V4) - Affiliate

Ron Torres

Modified on: Wed, 23 Sep, 2015 at 8:29 AM

NOTICE: THIS VERSION OF THE API HAS BEEN DEPRECATED. IT WILL CONTINUE TO WORK INDEFINITELY, BUT HAS INCREASED FUNCTIONALITY IN NEWER VERSIONS.

WSDL Page: http://<your_domain_here>/affiliate/api/4/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]

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]

sort_field / STRING = Sort Field ["click_date", "offer_id", "offer_name", "campaign_id", "subid_1", "subid_2", "subid_3", "subid_4", "subid_5", "ip_address", "paid_action", "total_clicks" ]

sort_descending / BOOL = Sort Descending? ["TRUE", "FALSE"]

Parameter Types:

api_key - ID

affiliate_id - ID

start_date - ID

end_date - ID

offer_id - ID

campaign_id - ID

start_at_row - ASSIGNABLE

row_limit - ASSIGNABLE

sort_field - ASSIGNABLE

sort_descending - ASSIGNABLE

Sample GET Call:

https://demo.cakemarketing.com/affiliates/api/4/reports.asmx/Clicks?api_key=LRKjY66p5iQz1WTtPMy6Q&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&start_at_row=1&row_limit=3&sort_field=click_date&sort_descending=FALSE

Sample XML Response:

<?xml version="1.0" encoding="UTF-8"?>
<click_response>
   <success>true</success>
   <row_count>1622</row_count>
   <summary>
      <paid_action>1622</paid_action>
      <total_clicks>1622</total_clicks>
   </summary>
   <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 />
         <total_clicks>1</total_clicks>
      </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 />
         <total_clicks>1</total_clicks>
      </click>
      <click>
         <click_date>2013-01-01T03:51:50.213</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 />
         <total_clicks>1</total_clicks>
      </click>
   </clicks>
</click_response>

Related Articles