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

 

Parameter Summary:

api_key / STRING = Admin API Key 

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

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

affiliate_id / INT = Affiliate ID ["0" = ALL Affiliates] {See export.asmx > Affiliates}

advertiser_id / INT = Advertiser ID ["0" = ALL Advertisers] {See export.asmx > Advertisers}

offer_id / INT = Offer ID ["0" = ALL Offers] {See export.asmx > Offers}

campaign_id / INT = Campaign ID ["0" = ALL Campaigns] {See export.asmx > Campaigns}

creative_id / INT = Creative ID ["0" = ALL Creatives] {See export.asmx > Creatives}

include_tests / BOOL = Include Test 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

start_date - ID

end_date - ID

affiliate_id - ID

advertiser_id - ID

offer_id - ID

campaign_id - ID

creative_id - ID

include_tests - ID

start_at_row - ID

row_limit - ID

 

Sample GET Call:

https://demo.cakemarketing.com/api/7/reports.asmx/Clicks?api_key=dNJFmId9rI&start_date=9/5/2013+12:00:00&end_date=9/6/2013+12:00:00&affiliate_id=0&advertiser_id=0&offer_id=0&campaign_id=0&creative_id=0&include_tests=false&start_at_row=0&row_limit=1

 

Sample XML Response:

<click_report_response>
  <success>true</success>
  <row_count>11</row_count>
  <clicks>
    <click>
      <click_id>4019485</click_id>
      <visitor_id>4758420</visitor_id>
      <request_session_id>4005529</request_session_id>
      <click_date>2014-04-22T13:47:25.697</click_date>
      <affiliate>
        <affiliate_id>-1</affiliate_id>
        <affiliate_name>Affiliate -1</affiliate_name>
      </affiliate>
      <advertiser>
        <advertiser_id>1</advertiser_id>
        <advertiser_name>Rename Advertiser</advertiser_name>
      </advertiser>
      <offer>
        <offer_id>-1</offer_id>
        <offer_name>Offer -1</offer_name>
      </offer>
      <offer_contract>
        <offer_contract_id>-1</offer_contract_id>
        <offer_contract_name>Offer Contract -1</offer_contract_name>
      </offer_contract>
      <campaign_id>-1</campaign_id>
      <creative>
        <creative_id>-1</creative_id>
        <creative_name>-1</creative_name>
      </creative>
      <sub_id_1/>
      <sub_id_2/>
      <sub_id_3/>
      <sub_id_4/>
      <sub_id_5/>
      <ip_address>66.249.65.104</ip_address>
      <user_agent>Mozilla/5.0%20(compatible;%20Googlebot/2.1;%20+http://www.google.com/bot.html)</user_agent>
      <referrer_url/>
      <search_term/>
      <request_url>http://dtrk.cakemarketing.com/</request_url>
      <redirect_url>http://getcake.com</redirect_url>
      <country>
        <country_code>US</country_code>
        <country_name>United States</country_name>
      </country>
      <region>
        <region_code>CA</region_code>
        <region_name>California</region_name>
      </region>
      <isp>
        <isp_id>7712</isp_id>
        <isp_name>Google Inc.</isp_name>
      </isp>
      <device>
        <device_id>-1</device_id>
        <device_name>Bot</device_name>
      </device>
      <operating_system>
        <operating_system_id>1</operating_system_id>
        <operating_system_name>Other</operating_system_name>
        <operating_system_version>
          <version_id>94</version_id>
          <version_name>Other</version_name>
        </operating_system_version>
        <operating_system_version_minor>
          <version_id>202</version_id>
          <version_name/>
        </operating_system_version_minor>
      </operating_system>
      <disposition>Base Tracking Domain Redirect</disposition>
      <total_clicks>1</total_clicks>
    </click>
  </clicks>
</click_report_response>