REPORTS OfferSummary API Version 3

Noor Khawaja

Modified on: Thu, 11 Jul, 2019 at 6:28 AM

REPORTS OfferSummary API Version 3

Updated on 2019-07-11
Current Version: Version 3
Deprecated Version: 2
Requests Allowed: GET/SOAP

Summary:

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

Resource/WSDL Page:

http://<yourdomainhere>.com/ api/3/reports.asmx?op=OfferSummary

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 Example Values: 2014-02-15 23:59:59 **You can only pull one month increments maximum
advertiser_id Required Type: INT Length (Max/Min): N/A	Obtained via GET Advertisers API. Pass 0 for all Example Values: 1234
advertiser_manager_id Required Type: INT Length (Max/Min): N/A	Obtained via EXPORT Advertisers API. Pass 0 for all Example Values: 1234
offer_id Required Type: INT Length (Max/Min): N/A	Obtained via EXPORT Offers API. Pass 0 for all Example Values: 1234
offer_tag_id Required Type: SHORT Length (Max/Min): N/A	Obtained via EXPORT Offers API. Pass 0 for all Example Values: 75, 94
affiliate_tag_id Required Type: SHORT 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
revenue_filter Required Type: STRING Length (Max/Min): N/A	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

GE T	http://demo.cakemarketing.com/api/3/reports.asmx/OfferSummary?api_key=oLrOexHsTsdTLb5GKJA0WUw1Lz22Ja1B&start_date=05-01-2019&end_date=05-05-2019&advertiser_id=0&advertiser_manager_id=0&offer_id=553&offer_tag_id=0&affiliate_tag_id=0&event_id=0&revenue_filter=conversions_and_events

Sample XML 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

Related Articles