REPORTS ClickExport Version 1 (DEPRECATED)

Ron Torres

Modified on: Fri, 18 Sep, 2015 at 5:44 PM

ClickExport API Version 1

Updated on 2014-04-02
Current Version: REPORTS Clicks Version 7

Deprecated Version: V1, V4, V5, V6

Requests Allowed: HTTP GET / HTTP POST / SOAP 1.1 / SOAP 1.2

Summary:

Include description that was added to the API categorization page here.

Where in the clients instance can this be done without the use of the API?

Resource/WSDL Page:

http://<your_domain_here>/api/1/reports.asmx?op=ClickExport

Parameters

api_key Required Value Type: STRING	Must be a valid API key (exisiting and NOT expired)
start_date Required Value Type: DATE	Start date for your report Example Values: Allowed formats: "YYYY-mm-dd","dd-mm-YYYY"
end_date Required Value Type: DATE	End date for your report Example Values: Allowed formats: "YYYY-mm-dd","dd-mm-YYYY"
affiliate_id Required Value Type: INT	Limit results to a specific affiliate onlyl Example Values: If passing anything <= 0 the result will include all affiliates.
offer_id Required Value Type: INT	Limit results to a specific offer only. Example Values: If passing anything <= 0 the result will include all offers.
campaign_id Optional Type: INT	Limit results to a specific offer only. Example Values: If passing anything <= 0 the result will include all campaigns.
include_tests Required Value Type: BOOL	Limit results to non-test clicks only. Example Values: TRUE, FALSE

**Note all optional parameters still need to be passed through in the actual call. These parameters do not need a value (therefore you can use a null value).

Example Request

GET	http://demo.cakemarketing.com/api/1/reports.asmx/ClickExport?api_key=dNJFmId9rI&start_date=01/01/2012+12:00:00&end_date=01/01/2012+17:00:00&affiliate_id=4410&offer_id=0&include_tests=TRUE

Sample XML Response:

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfClick xmlns="http://cakemarketing.com/api/1/">
  <Click>
    <click_id>int</click_id>
    <visitor_id>int</visitor_id>
    <request_session_id>int</request_session_id>
    <click_date>dateTime</click_date>
    <affiliate_id>int</affiliate_id>
    <affiliate_name>string</affiliate_name>
    <offer_id>int</offer_id>
    <offer_name>string</offer_name>
    <advertiser_id>int</advertiser_id>
    <advertiser_name>string</advertiser_name>
    <campaign_id>int</campaign_id>
    <creative_id>int</creative_id>
    <creative_name>string</creative_name>
    <subid_1>string</subid_1>
    <subid_2>string</subid_2>
    <subid_3>string</subid_3>
    <subid_4>string</subid_4>
    <subid_5>string</subid_5>
    <ip_address>string</ip_address>
    <country>string</country>
    <user_agent>string</user_agent>
    <referrer_url>string</referrer_url>
    <request_url>string</request_url>
    <redirect_url>string</redirect_url>
    <disposition>string</disposition>
    <paid_action>string</paid_action>
    <total_clicks>int</total_clicks>
  </Click>
  <Click>
    <click_id>int</click_id>
    <visitor_id>int</visitor_id>
    <request_session_id>int</request_session_id>
    <click_date>dateTime</click_date>
    <affiliate_id>int</affiliate_id>
    <affiliate_name>string</affiliate_name>
    <offer_id>int</offer_id>
    <offer_name>string</offer_name>
    <advertiser_id>int</advertiser_id>
    <advertiser_name>string</advertiser_name>
    <campaign_id>int</campaign_id>
    <creative_id>int</creative_id>
    <creative_name>string</creative_name>
    <subid_1>string</subid_1>
    <subid_2>string</subid_2>
    <subid_3>string</subid_3>
    <subid_4>string</subid_4>
    <subid_5>string</subid_5>
    <ip_address>string</ip_address>
    <country>string</country>
    <user_agent>string</user_agent>
    <referrer_url>string</referrer_url>
    <request_url>string</request_url>
    <redirect_url>string</redirect_url>
    <disposition>string</disposition>
    <paid_action>string</paid_action>
    <total_clicks>int</total_clicks>
  </Click>
</ArrayOfClick>

Example Error Messages:

Error Message	Likely Cause
Invalid API Key	API key does not exist or is expired.