REPORTS Clicks API Version 10

Updated on 2015-01-13
Current Version: Version 10
Deprecated Version: V4, V5, V6, V7, V8, V9
Requests Allowed: GET & SOAP

 

Summary:

Exports all clicks info filtered by campaign, affiliate offer, advertiser, or creative.

You can also obtain this from within your CAKE instance by going to  the Reports main tab then the Clicks sub tab where you are allowed to  export. 

 

Resource/WSDL Page:

http://<your_domain_here>/api/10/reports.asmx?op=Clicks


Parameters:

api_key
Required
Type: STRING
Length (Max/Min): 50

Must be a valid API key (existing and NOT expired)

Example Values: Fo35NRAqvFLXoZxqB4aViaiYM7iVMhh
start_date
Required
Type: DATETIME
Length (Max/Min): N/A

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

Example Values: 12/31/2013 15:16:17

end_date
Required
Type: DATETIME
Length (Max/Min): N/A

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

When time stamp is excluded 00:00:00 is assumed. Data on end date will not be included.

Example Values: 12/31/2013 15:16:17

affiliate_id
Required
Type: INTEGER
Length (Max/Min): N/A


This is the identifier for a unique Affiliate.  Obtained via EXPORT Affiliates API

Example Values: 1234
advertiser_id
Required
Type: INTEGER
Length (Max/Min): N/A


This is the identifier for a unique Advertiser.  Obtained via EXPORT Advertisers API

Example Values: 1234
offer_id
Required
Type: INTEGER
Length (Max/Min): N/A



This is the identifier for a unique Offer.  Obtained via EXPORT Offers API

Example Values: 1234
campaign_id
Required
Type: INTEGER
Length (Max/Min): N/A



This is the identifier for a unique campaign. Obtained via EXPORT Campaigns API

Example Values: 1234

creative_id
Required
Type: INTEGER
Length (Max/Min): N/A



This is the identifier for a unique creative. Obtained via EXPORT Creatives API

Example Values: 1234

price_format_id
Required
Type: INTEGER
Length (Max/Min): N/A



Obtained via GET PriceFormats API Version 1. Pass 0 for all

Example Values: TRUE

include_tests
Required
Type: BOOL
Length (Max/Min): N/A
Example Values: True, False
start_at_row
Required
Type: INTEGER
Length (Max/Min): N/A



Must pass at least 0 as value, which means start at the beginning of the data set.

Example Values: 3
row_limit
Required
Type: INTEGER
Length (Max/Min): N/A

Must pass at least 0 as value, which means no limit.

Example Values: 3
include_duplicates
Required
Type: BOOLEAN
Length (Max/Min): 50

Includes all clicks if 'true'

Example Values: 'yes'
**Duplicate click data is only available up to the 1st day of the previous month.

 **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
https://demo.cakemarketing.com/api/11/reports.asmx/Clicks?api_key=dNJFmId9rI&start_date=08/4/2015&end_date=12/31/2015&affiliate_id=1111667&advertiser_id=0&offer_id=0&campaign_id=0&creative_id=0&price_format_id=0&include_tests=false&start_at_row=0&row_limit=0&include_duplicates=false


Sample XML Response:

   

<click_report_response xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://cakemarketing.com/api/10/">
<success>true</success>
<row_count>19</row_count>
<clicks>
<click>
<click_id>4091680</click_id>
<visitor_id>4865792</visitor_id>
<request_session_id>4118964</request_session_id>
<click_date>2015-12-29T10:38:32.88</click_date>
<source_affiliate>
<source_affiliate_id xmlns="API:id_name_store">1111667</source_affiliate_id>
<source_affiliate_name xmlns="API:id_name_store">Tim's Affiliate 2</source_affiliate_name>
</source_affiliate>
<brand_advertiser>
<brand_advertiser_id xmlns="API:id_name_store">900988</brand_advertiser_id>
<brand_advertiser_name xmlns="API:id_name_store">Tim's Advertiser 2</brand_advertiser_name>
</brand_advertiser>
<site_offer>
<site_offer_id xmlns="API:id_name_store">55379026</site_offer_id>
<site_offer_name xmlns="API:id_name_store">Tim's Offer Multiple Contracts</site_offer_name>
</site_offer>
<site_offer_contract>
<site_offer_contract_id xmlns="API:id_name_store">7015</site_offer_contract_id>
<site_offer_contract_name xmlns="API:id_name_store">CPC</site_offer_contract_name>
</site_offer_contract>
<campaign>
<campaign_id>763122</campaign_id>
<campaign_type>
<campaign_type_id>1</campaign_type_id>
<campaign_type_name>Standard</campaign_type_name>
</campaign_type>
</campaign>
<creative>
<creative_id xmlns="API:id_name_store">1137030</creative_id>
<creative_name xmlns="API:id_name_store">1137030</creative_name>
</creative>
<sub_id_1>Aff2</sub_id_1>
<sub_id_2>subid2</sub_id_2>
<sub_id_3/>
<sub_id_4/>
<sub_id_5/>
<ip_address>12.199.136.146</ip_address>
<user_agent>
Mozilla/5.0%20(Macintosh;%20Intel%20Mac%20OS%20X%2010.10;%20rv:43.0)%20Gecko/20100101%20Firefox/43.0
</user_agent>
<referrer_url/>
<search_term/>
<request_url>
http://stagingtrk.cakemarketing.com/?a=1111667&c=1137030&p=c&s1=Aff2&s2=subid2
</request_url>
<redirect_url>
http://www.google.com?afid=#affid#&abc=#s1#&country=#country#&region=#region#&APIKEY=#apikey#&s5=#s5#
</redirect_url>
<country>
<country_code xmlns="API:id_name_store">US</country_code>
<country_name xmlns="API:id_name_store">United States</country_name>
</country>
<region>
<region_code xmlns="API:id_name_store">CA</region_code>
<region_name xmlns="API:id_name_store">California</region_name>
</region>
<language>
<language_id xmlns="API:id_name_store">1</language_id>
<language_name xmlns="API:id_name_store">English</language_name>
</language>
<isp>
<isp_id xmlns="API:id_name_store">33036</isp_id>
<isp_name xmlns="API:id_name_store">Att Services Inc.</isp_name>
</isp>
<operating_system>
<operating_system_id>17</operating_system_id>
<operating_system_name>Mac Os</operating_system_name>
<operating_system_version>
<version_id xmlns="API:id_name_store">105</version_id>
<version_name xmlns="API:id_name_store">Yosemite (10.10)</version_name>
</operating_system_version>
<operating_system_version_minor>
<version_id xmlns="API:id_name_store">227</version_id>
<version_name xmlns="API:id_name_store"/>
</operating_system_version_minor>
</operating_system>
<browser>
<browser_id>3</browser_id>
<browser_name>Firefox</browser_name>
<browser_version>
<version_id xmlns="API:id_name_store">45</version_id>
<version_name xmlns="API:id_name_store">Other</version_name>
</browser_version>
<browser_version_minor>
<version_id xmlns="API:id_name_store">45</version_id>
<version_name xmlns="API:id_name_store"/>
</browser_version_minor>
</browser>
<disposition/>
<paid_action>869630</paid_action>
<paid>
<currency_id>1</currency_id>
<amount>2.0000</amount>
<formatted_amount>$2.00</formatted_amount>
</paid>
<received>
<currency_id>3</currency_id>
<amount>5.0000</amount>
<formatted_amount>£5.00</formatted_amount>
</received>
<duplicate>false</duplicate>
<duplicate_clicks>0</duplicate_clicks>
<total_clicks>1</total_clicks>
</click>

   

 

Example Error Messages:

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