REPORTS Clicks API Version 12
Modified on: Mon, 23 Oct, 2017 at 3:45 PM
Summary
Exports all clicks info filtered by Campaign, Affiliate, Offer, Advertiser, or Creative.
You can also obtain this data from within your CAKE instance by going to the Reports main tab, then the Clicks sub tab, where you are allowed to export.
Current Version: Version 12
Deprecated Versions: V7, V9, V10, V11
Requests Allowed: GET & SOAP
Resource / WSDL Page
http://<your_domain_here>/api/12/reports.asmx?op=Clicks
Parameters
All parameters are required in every API call. Parameters not being used for filtering should be passed with a value of 0 (integers) or false (booleans).
| Parameter | Required | Type | Description |
|---|---|---|---|
api_key | Required | STRING | Valid API key (not expired). Max 50 chars. Example: Fo35NRAqvFLXoZxqB4aViaiYM7iVMhh |
start_date | Required | DATETIME | Report start date. Format: MM/DD/YYYY HH:MM:SSExample: 12/31/2013 15:16:17 |
end_date | Required | DATETIME | Report end date. When time is excluded, 00:00:00 is assumed. Data on end date is not included.Example: 12/31/2013 15:16:17 |
affiliate_id | Required | INTEGER | Unique Affiliate ID. Obtained via EXPORT Affiliates API. Pass 0 for all.Example: 1234 |
advertiser_id | Required | INTEGER | Unique Advertiser ID. Obtained via EXPORT Advertisers API. Pass 0 for all.Example: 1234 |
offer_id | Required | INTEGER | Unique Offer ID. Obtained via EXPORT Offers API. Pass 0 for all.Example: 1234 |
campaign_id | Required | INTEGER | Unique Campaign ID. Obtained via EXPORT Campaigns API. Pass 0 for all.Example: 1234 |
creative_id | Required | INTEGER | Unique Creative ID. Obtained via EXPORT Creatives API. Pass 0 for all.Example: 1234 |
price_format_id | Required | INTEGER | Obtained via GET PriceFormats API Version 1. Pass 0 for all. |
include_tests | Required | BOOLEAN | Include test clicks in results. Example: true, false |
start_at_row | Required | INTEGER | Row offset for pagination. Pass 0 to start at the beginning.Example: 3 |
row_limit | Required | INTEGER | Maximum rows returned. Pass 0 for no limit.Example: 3 |
include_duplicates | Required | BOOLEAN | Set to true to include all clicks. Duplicate click data is only available up to the 1st day of the previous month.Example: true, false |
Example Request
GET request using the demo environment:
GET https://demo-new.cakemarketing.com/api/12/reports.asmx/Clicks ?api_key=7kkLImWsRr2kPLjBwrPEd2g07ks8daj &start_date=06/1/2017 &end_date=06/25/2017 &affiliate_id=14774 &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=500 &include_duplicates=false
Sample XML Response
<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/12/">
<success>true</success>
<row_count>1</row_count>
<clicks>
<click>
<click_id>4626602</click_id>
<visitor_id>5668290</visitor_id>
<tracking_id>1609510</tracking_id>
<request_session_id>4923658</request_session_id>
<click_date>2017-06-20T23:38:47.403</click_date>
<udid>Device ID1230</udid>
<source_affiliate>
<source_affiliate_id>-1</source_affiliate_id>
<source_affiliate_name>Affiliate -1</source_affiliate_name>
</source_affiliate>
<brand_advertiser>
<brand_advertiser_id>1</brand_advertiser_id>
<brand_advertiser_name>CAKE</brand_advertiser_name>
</brand_advertiser>
<site_offer>
<site_offer_id>-1</site_offer_id>
<site_offer_name>Offer -1</site_offer_name>
</site_offer>
<site_offer_contract>
<site_offer_contract_id>-1</site_offer_contract_id>
<site_offer_contract_name>Offer Contract -1</site_offer_contract_name>
</site_offer_contract>
<channel>
<channel_id>1</channel_id>
<channel_name>Affiliate</channel_name>
</channel>
<campaign>
<campaign_id>-1</campaign_id>
<campaign_name>My Campaign Name</campaign_name>
<campaign_type>
<campaign_type_id>1</campaign_type_id>
<campaign_type_name>Standard</campaign_type_name>
</campaign_type>
</campaign>
<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>91.230.47.3</ip_address>
<user_agent/>
<referrer_url/>
<search_term/>
<request_url>http://192.168.101.140/</request_url>
<redirect_url>http://www.amazon.com</redirect_url>
<country>
<country_code>RU</country_code>
<country_name>Russian Federation</country_name>
</country>
<region>
<region_code>MOW</region_code>
<region_name>Moskva</region_name>
</region>
<isp>
<isp_id>69255</isp_id>
<isp_name>Regionalnaya Kompaniya Svyazi Ltd.</isp_name>
</isp>
<disposition>Base Tracking Domain Redirect</disposition>
<duplicate>false</duplicate>
<duplicate_clicks>0</duplicate_clicks>
<total_clicks>1</total_clicks>
</click>
</clicks>
</click_report_response>Note All optional parameters must still be passed in the request. Parameters not used for filtering can be passed as a null value.