REPORTS Clicks API Version 11
Updated on 2015-01-13
Current Version: Version 10
Deprecated Version: V7, V9, v10
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/11/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
<click_report_response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://cakemarketing.com/api/11/"> <success>true</success> <row_count>26</row_count> <clicks> <click> <click_id>46576098</click_id> <visitor_id>23227197</visitor_id> <tracking_id>1292734</tracking_id> <request_session_id>25385133</request_session_id> <click_date>2017-06-23T12:17:17.2</click_date> <source_affiliate> <source_affiliate_id xmlns="API:id_name_store">14774</source_affiliate_id> <source_affiliate_name xmlns="API:id_name_store">LC Aff test</source_affiliate_name> </source_affiliate> <brand_advertiser> <brand_advertiser_id xmlns="API:id_name_store">344</brand_advertiser_id> <brand_advertiser_name xmlns="API:id_name_store">Bobby Test Adv</brand_advertiser_name> </brand_advertiser> <site_offer> <site_offer_id xmlns="API:id_name_store">19509</site_offer_id> <site_offer_name xmlns="API:id_name_store">LC OL Test</site_offer_name> </site_offer> <site_offer_contract> <site_offer_contract_id xmlns="API:id_name_store">20508</site_offer_contract_id> <site_offer_contract_name xmlns="API:id_name_store">RESPONSIVE default</site_offer_contract_name> </site_offer_contract> <campaign> <campaign_id>45531</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">25542</creative_id> <creative_name xmlns="API:id_name_store">25542</creative_name> </creative> <sub_id_1/> <sub_id_2/> <sub_id_3/> <sub_id_4/> <sub_id_5/> <ip_address>12.9.20.2</ip_address> <user_agent> Mozilla/5.0%20(Macintosh;%20Intel%20Mac%20OS%20X%2010_12_3)%20AppleWebKit/537.36%20(KHTML,%20like%20Gecko)%20Chrome/58.0.3029.110%20Safari/537.36 </user_agent> <referrer_url> http://demo-new.cakemarketing.com/test.aspx?c=45531 </referrer_url> <search_term/> <request_url> https://demo-newtrk.cakemarketing.com/?E=oi2LroPymtowVV7UHt9WGbDroh8ARz4T&s1= </request_url> <redirect_url> https://nike.com/?s2=#oreqid#&s2=#afftpid#&s3=#camptpid# </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">15</version_id> <version_name xmlns="API:id_name_store">Puma (10.1)</version_name> </operating_system_version> <operating_system_version_minor> <version_id xmlns="API:id_name_store">15</version_id> <version_name xmlns="API:id_name_store"/> </operating_system_version_minor> </operating_system> <browser> <browser_id>2</browser_id> <browser_name>Chrome</browser_name> <browser_version> <version_id xmlns="API:id_name_store">460</version_id> <version_name xmlns="API:id_name_store">58</version_name> </browser_version> <browser_version_minor> <version_id xmlns="API:id_name_store">691</version_id> <version_name xmlns="API:id_name_store">58.0</version_name> </browser_version_minor> </browser> <disposition/> <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 |