REPORTS Clicks API

Updated on 2014-03-31
Current Version: Version 7
Deprecated Version: V1, V4, V5, V6
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/7/reports.asmx?op=Clicks

 

Parameters

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

This api_key will provide you with the ability to export Clicks for your instance. You can obtain this api_key from within CAKE >> Setup >> Permissions in the API Key list.

Example Value: 

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]

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.  This can be found on any Affiliate card.

Example Values: 1234

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

This is the identifier for a unique Advertiser.  This can be found on any Affiliate card.

Example Values: 1234

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

This is the identifier for a unique Offer.  This can be found on any Offer card.

Example Values: 1234

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

This is the identifier for a unique campaign. You can obtain the campaign ID from your CAKE instance on the campaign card. To get there, go to the advertiser tab >> offers >> choose an offer to open the offer card >> campaign tab >> choose a campaign >> ID. 

Example Values: 1234

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

 

This is the identifier for a unique creative. You can obtain the creative ID from your CAKE instance on the offer card. To get there, go to the advertiser tab >> offers >> choose an offer to open the offer card >> creatives tab >> choose a creative >> ID. 

Example Values: 1234

include_tests
Required
Type: BOOL
Length (Max/Min): N/A

The following values can only be used for this parameter (TRUE or FALSE).

Example Values: TRUE

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

 **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/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>4732</row_count><clicks><click><click_id>3755482</click_id><visitor_id>4466518</visitor_id><request_session_id>3712474</request_session_id><click_date>2013-09-05T12:00:48.74</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>159.253.147.194</ip_address><user_agent>DOSarrest%20Monitor/1.3%20(Linux)</user_agent><referrer_url/><search_term/><request_url>http://ckdns.co/</request_url><redirect_url>http://getcake.com</redirect_url><country><country_code>CA</country_code><country_name>Canada</country_name></country><isp><isp_id>26108</isp_id><isp_name>Softlayer Technologies Inc.</isp_name></isp><operating_system><operating_system_id>19</operating_system_id><operating_system_name>Linux</operating_system_name><operating_system_version><version_id>95</version_id><version_name>Other</version_name></operating_system_version><operating_system_version_minor><version_id>203</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>     
  

 

Example Error Messages: 

Error Message

Likely Cause

Invalid API Key

API Key does not exist or is expired