Submit a Ticket My Tickets
Welcome
Login  Sign up

REPORTS DailySummaryExport API Version 2


Reports DailySummaryExport API Version 2

Updated on 07-18-2017
Current Version: Version 2
Deprecated Version: V1
Requests Allowed: GET&SOAP

Summary:

Returns an array of the daily summary reports filterable by affiliate, advertiser, offer, vertical, campaign, creative and account manager. 

Resource/WSDL Page:

http://yourdomainhere.com/api/2/reports.asmx?op=DailySummaryExport

 

Parameters

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

Must be a valid API key (existing and NOT expired)
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, and data on end date will not be included.
Allowed formats: "YYYY-mm-dd", "dd-mm-YYYY" 
source_affiliate_id
Required
Type: INT
Length (Max/Min): NA
If passing anything <= 0 the result will include all affiliates.
brand_advertiser_id
Required
Type: INT
Length (Max/Min): NA
If passing anything <= 0 the result will include all advertisers.
site_offer_id
Required
Type: INT
Length (Max/Min): NA
If passing anything <= 0 the result will include all offers.
vertical_id
Required
Type: SHORT
Length (Max/Min): NA
If passing anything <= 0 the result will include all verticals.
campaign_id
Required
Type: INT
Length (Max/Min): NA
If passing anything <= 0 the result will include all campaigns.
creative_id
Required
Type: INT
Length (Max/Min): NA
If passing anything <= 0 the result will include all creatives.
account_manager_id
Required
Type: INT
Length (Max/Min): NA
If passing anything <= 0 the result will include all account managers.
include_tests
Required
Type: BOOL
Length (Max/Min): N/A
 Example Values: True, False

 **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-new.cakemarketing.com/api/1/reports.asmx/DailySummaryExport?api_key=BETwue0XUuMnZitzyqzddodKbz08h7&start_date=05/01/2017&end_date=05/25/2017&affiliate_id=0&advertiser_id=0&offer_id=0&vertical_id=0&campaign_id=0&creative_id=0&account_manager_id=0&include_tests=true
 

 

Sample XML Response:


<ArrayOfDailySummary xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://cakemarketing.com/api/1/">
<DailySummary>
<date>2017-05-01T00:00:00</date>
<views>0</views>
<clicks>4</clicks>
<click_thru>0.000000</click_thru>
<conversions>8</conversions>
<paid>5</paid>
<sellable>10</sellable>
<conversion_rate>1.250000</conversion_rate>
<cpl>5.000000</cpl>
<cost>50.0000</cost>
<rpt>9.000000</rpt>
<revenue>90.0000</revenue>
<margin>0.4444</margin>
<profit>40.0000</profit>
<epc>12.500000</epc>
</DailySummary>
<DailySummary>
<date>2017-05-02T00:00:00</date>
<views>0</views>
<clicks>26</clicks>
<click_thru>0.000000</click_thru>
<conversions>30</conversions>
<paid>20</paid>
<sellable>30</sellable>
<conversion_rate>0.769230</conversion_rate>
<cpl>6.766667</cpl>
<cost>203.0000</cost>
<rpt>6.416667</rpt>
<revenue>192.5000</revenue>
<margin>-0.0545</margin>
<profit>-10.5000</profit>
<epc>7.807692</epc>
</DailySummary>
<DailySummary>
<date>2017-05-03T00:00:00</date>
<views>0</views>
<clicks>5</clicks>
<click_thru>0.000000</click_thru>
<conversions>28</conversions>
<paid>6</paid>
<sellable>28</sellable>
<conversion_rate>1.200000</conversion_rate>
<cpl>2.464286</cpl>
<cost>69.0000</cost>
<rpt>24.821429</rpt>
<revenue>695.0000</revenue>
<margin>0.9007</margin>
<profit>626.0000</profit>
<epc>13.800000</epc>
</DailySummary>



Example Error Messages: 

Error Message
Likely Cause
Invalid API Key
API key does not exist or is expired

 




















Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.