Reports DailySummaryExport API
Updated on 2014-04-01
Current Version: Version 1
Deprecated Version:
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/1/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" |
|
affiliate_id Required Type: INT Length (Max/Min): NA |
If passing anything <= 0 the result will include all affiliates. |
|
advertiser_id Required Type: INT Length (Max/Min): NA |
If passing anything <= 0 the result will include all advertisers. |
|
offer_id Required Type: INT Length (Max/Min): NA |
If passing anything <= 0 the result will include all offers. |
|
vertical_id Required Type: INT 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 |
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
Sample XML Response:
<ArrayOfDailySummary><DailySummary><date>2015-05-01T00:00:00</date><views>0</views><clicks>20</clicks><click_thru>0.000000</click_thru><conversions>2</conversions><paid>2</paid><sellable>2</sellable><conversion_rate>0.100000</conversion_rate><cpl>6.000000</cpl><cost>12.0000</cost><rpt>10.000000</rpt><revenue>20.0000</revenue><margin>0.4000</margin><profit>8.0000</profit><epc>0.600000</epc></DailySummary><DailySummary><date>2015-05-02T00:00:00</date><views>0</views><clicks>37</clicks><click_thru>0.000000</click_thru><conversions>0</conversions><paid>0</paid><sellable>0</sellable><conversion_rate>0.000000</conversion_rate><cpl>0.000000</cpl><cost>0.0000</cost><rpt>0.000000</rpt><revenue>0.0000</revenue><margin>0.0000</margin><profit>0.0000</profit><epc>0.000000</epc></DailySummary></ArrayOfDailySummary>
Example Error Messages:
|
Error Message |
Likely Cause |
| Invalid API Key |
API key does not exist or is expired |