CAKE Help & Support

REPORTS SiteOfferSummary API Version 4

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


REPORTS SiteOfferSummary API Version 4

Updated on 2016-02-09
Current Version: Version 4
Deprecated Version: 1, 2, 3
Requests Allowed: GET/SOAP

 
Summary:

This API will return an offer/site performance overview for a given period

 

Resource/WSDL Page:

http://yourdomainhere.com/api/4/reports.asmx?op=SiteOfferSummary

 

Parameters

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

This api_key must be a valid API key (exisiting and NOT expired). You can obtain this api_key from within CAKE >> Setup >> Permissions in the API Key list.  

Example Values: 

Fo35NRAqvFLXoZxqB4aViaiYM7iVMhh

start_date
Required
Type: DATE
Length (Max/Min): N/A


Allowed formats: YYYY-MM-DD hh:mm:ss, MM-DD-YYYY hh:mm:ss

Example Values: 2014-02-15 00:00:00

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

Allowed formats: YYYY-MM-DD hh:mm:ss, MM-DD-YYYY hh:mm:ss

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

Example Values: 2014-02-15 23:59:59

**You can only pull one month increments maximum

brand_advertiser_id
Required
Type: INT
Length (Max/Min): N/A

Obtained via GET Advertisers API. Pass 0 for all
Example Values: 1234

brand_advertiser_manager_id
Required
Type: INT
Length (Max/Min): N/A

Obtained via EXPORT Advertisers API. Pass 0 for all 
Example Values: 1234

site_offer_id
Required
Type: INT
Length (Max/Min): N/A

Obtained via EXPORT Offers API. Pass 0 for all

Example Values: 1234

site_offer_tag_id
Required
Type: INT
Length (Max/Min): N/A

Obtained via EXPORT Offers API. Pass 0 for all

Example Values: 75, 94

source_affiliate_tag_id
Required
Type: INT
Length (Max/Min): N/A

Obtained via GET AffiliateTagsAPI. Pass 0 for all
Example Values: 3, 5, 78

event_id
Required
Type: INT
Length (Max/Min): N/A

Obtained via EXPORT Advertisers API. Pass 0 for all

Example Values: 0, 75, 4864

event_type
Required
Type: ENUM
Length (Max/Min): N/A

Allows you to filter only events/micro events, only conversions/macro events, or all

Example Values:  "all", "macro_event_conversions" or "micro_event_conversions"

 **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

http://demo.cakemarketing.com/api/4/reports.asmx/SiteOfferSummary?api_key=oLrOexHsTsdTLb5GKJA0WUw1Lz22Ja1B&start_date=01-01-2016&end_date=01-31-2016&brand_advertiser_id=0&brand_advertiser_manager_id=0&site_offer_id=0&site_offer_tag_id=0&source_affiliate_tag_id=0&event_id=0&event_type=all 


Sample XML Response:

 

site_offer_summary_report_response xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://cakemarketing.com/api/4/">
<success>true</success>
<row_count>1</row_count>
<site_offers>
<site_offer_summary>
<site_offer>
<site_offer_id xmlns="API:id_name_store">-1</site_offer_id>
<site_offer_name xmlns="API:id_name_store">Offer -1</site_offer_name>
</site_offer>
<brand_advertiser>
<brand_advertiser_id xmlns="API:id_name_store">1</brand_advertiser_id>
<brand_advertiser_name xmlns="API:id_name_store">CAKE</brand_advertiser_name>
</brand_advertiser>
<vertical>
<vertical_id xmlns="API:id_name_store">-1</vertical_id>
<vertical_name xmlns="API:id_name_store">Global</vertical_name>
</vertical>
<account_manager>
<account_manager_id xmlns="API:id_name_store">3733</account_manager_id>
<account_manager_name xmlns="API:id_name_store">Rofek Admin</account_manager_name>
</account_manager>
<views>6</views>
<clicks>520</clicks>
<click_thru_percentage>8666.666700</click_thru_percentage>
<macro_event_conversions>0.000000</macro_event_conversions>
<paid>0.000000</paid>
<sellable>0.000000</sellable>
<micro_events>0.000000</micro_events>
<macro_event_conversion_percentage>0.000000</macro_event_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.000000</pending>
<rejected>0.000000</rejected>
<approved>0.000000</approved>
<returned>0.000000</returned>
<orders>0</orders>
<order_total>0.0000</order_total>
<average_order_value>0.000000</average_order_value>
<average_macro_event_conversion_score>0.000000</average_macro_event_conversion_score>
<paid_events>0.000000</paid_events>
<total_paid>0.000000</total_paid>
</site_offer_summary>
<site_offer_summary>
</site_offer_summary_report_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

Invalid Offer ID

Offer requested does not exist

 

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