REPORTS OfferSummary API Version 2
Updated on 2014-04-04
Current Version: Version 2
Deprecated Version:
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/2/reports.asmx?op=OfferSummary
Parameters
api_key |
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 |
Allowed formats: YYYY-MM-DD hh:mm:ss, MM-DD-YYYY hh:mm:ss Example Values: 2014-02-15 00:00:00 |
end_date |
Allowed formats: YYYY-MM-DD hh:mm:ss, MM-DD-YYYY hh:mm:ss Example Values: 2014-02-15 23:59:59 **You can only pull one month increments maximum |
advertiser_id |
Obtained via GET Advertisers API. Pass 0 for all |
advertiser_manager_id |
Obtained via EXPORT Advertisers API. Pass 0 for all |
offer_id |
Obtained via EXPORT Offers API. Pass 0 for all Example Values: 1234 |
offer_tag_id |
Obtained via EXPORT Offers API. Pass 0 for all Example Values: 75, 94 |
affiliate_tag_id |
Obtained via GET AffiliateTagsAPI. Pass 0 for all |
event_id |
Obtained via EXPORT Advertisers API. Pass 0 for all Example Values: 0, 75, 4864 |
revenue_filter |
Allows you to filter only events, only conversions or both. |
**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 |
Sample XML Response:
<offer_summary_report_response><success>true</success><row_count>1</row_count><offers><offer_summary><offer><offer_id>55379585</offer_id><offer_name>Ron CAKE Test</offer_name></offer><advertiser><advertiser_id>900280</advertiser_id><advertiser_name>!!! Eddy & Dylan</advertiser_name></advertiser><account_manager><account_manager_id>1120</account_manager_id><account_manager_name>John Doe</account_manager_name></account_manager><views>0</views><clicks>5</clicks><click_thru_percentage>0.000000</click_thru_percentage><conversions>5</conversions><paid>5</paid><sellable>5</sellable><events>0</events><conversion_percentage>100.000000</conversion_percentage><cost>5.0000</cost><average_cost>1.000000</average_cost><epc>1.000000</epc><revenue>5.0000</revenue><revenue_per_transaction>1.000000</revenue_per_transaction><margin>0.0000</margin><profit>0.0000</profit><pending>5</pending><rejected>0</rejected><approved>0</approved><returned>0</returned><orders>0</orders><order_total>0.0000</order_total><average_order_value>0.000000</average_order_value><average_conversion_score>0.00</average_conversion_score></offer_summary></offers></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 |