CAKE Help & Support

REPORTS AdvertiserSummary API Version 2

Modified on: Wed, 11 May, 2016 at 2:13 PM


REPORTS AdvertiserSummary API

Updated on 2014-04-04
Current Version: Version 2
Deprecated Version: 
Requests Allowed: GET/SOAP/Both

 

Summary:

This API will allow you to see a summary of all advertiser traffic ran during a certain period of time. It allows to filter down by Advertiser manager, Advertiser Tag, Event ID or events & conversions. 

This is the equivalent to running an advertiser report in the UI.

 

Resource/WSDL Page:

http://<your_domain_here>/api/2/reports.asmx?op=AdvertiserSummary

 

Parameters

 

api_key
Required
Type: String
Length (Max):  50

As an administrator to your CAKE instance, you can obtain your API key in one of two ways. 1.) From within your instance >> setup tab >> permissions. 2.) Using the GET GetAPIKey

Example Values: dNJFmId9rIZZrs

 
 

start_date
Required 
Type: Date
Length (Max/Min):  NA

Allowed formats: "YYYY-mm-dd","dd-mm-YYYY"
 

end_date
Required 
Type: Date
Length (Max/Min):  NA

When time stamp is excluded 00:00:00 is assumed. Data on end date will not be included.
Allowed formats: "YYYY-mm-dd","dd-mm-YYYY"

advertiser_id
Required Value
Type: INT
Length (Max/Min): NA

For all advertisers pass 0, for a specific one pass the ID. The ID can be found in the advertiser card in the UI.

Example Values: 0, 75, 4864

 

advertiser_manager_id
Required Value
Type: INT
Length (Max/Min): NA

 

For all advertisers managers pass 0, for a specific one pass the ID. The ID can be found in the advertiser manager contact's card in the UI.

Example Values: 0, 75, 4864

 

advertiser_tag_id
Required Value
Type: INT
Length (Max/Min): NA

 

For all advertisers tags 0, for a specific one pass the ID. The ID can't be found currently in the UI

Example Values: 0, 75, 4864

 

event_id
Required Value
Type: INT
Length (Max/Min): NA

 

For all events 0, for a specific one pass the ID. The ID can be found in the advertiser and offer card which contains the event under the event's tab.

Example Values: 0, 75, 4864

 

revenue_filter
Required Value
Type: INT
Length (Max/Min): NA

Allows you to filter only events, only conversions or both.

Example Values:  "conversions_and_events", "conversions" or "events"

 

 **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/2/reports.asmx/AdvertiserSummary?
api_key=dNJFmId9rI&start_date=2014-04-01&end_date=2014-04-04&advertiser_id=0&advertiser_manager_id=0&advertiser_tag_id=0&event_id=0&
revenue_filter=conversions_and_events

 

Sample XML Response:

<advertiser_summary_response xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://cakemarketing.com/api/2/">
<success>true</success>
<row_count>1</row_count>
<advertisers>
<advertiser_summary>
<advertiser>
<advertiser_id xmlns="API:id_name_store">46</advertiser_id>
<advertiser_name xmlns="API:id_name_store">1Tea.com</advertiser_name>
</advertiser>
<account_manager>
<account_manager_id xmlns="API:id_name_store">3537</account_manager_id>
<account_manager_name xmlns="API:id_name_store">Ben Cockburn</account_manager_name>
</account_manager>
<views>0</views>
<clicks>5</clicks>
<click_thru_percentage>0.000000</click_thru_percentage>
<conversions>2</conversions>
<paid>0</paid>
<sellable>7</sellable>
<events>5</events>
<conversion_percentage>0.000000</conversion_percentage>
<cost>0.0000</cost>
<average_cost>0.000000</average_cost>
<epc>0.000000</epc>
<revenue>0.0000</revenue>
<revenue_per_transaction>0.000000</revenue_per_transaction>
<margin>0.0000</margin>
<profit>0.0000</profit>
<pending>0</pending>
<rejected>0</rejected>
<approved>7</approved>
<returned>0</returned>
<orders>0</orders>
<order_total>0.0000</order_total>
<average_order_value>0.000000</average_order_value>
</advertiser_summary>
</advertisers>
</advertiser_summary_response>

 

Example Error Messages: 

Error Message

Likely Cause

Invalid API Key

API key does not exist or is expired.

Date Range Too Long

 Date Range is grater than 31 days.
 

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.
Login
New support ticket Check ticket status