REPORTS OfferSummary API Version 3
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 | 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
GE T |
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 |