Reporting XML API Reference

Home Knowledge Base Publisher Reporting XML API Reference

Simple Publisher Reporting XML API has been designed to provide the publishers with requests (searches), clicks, invalid clicks, and revenue data for the desired period of time.

Request URL:

http://api.adx1.com/api/reports/?from=[from_date]&to=[to_date]&segment=[segment]&output=xml&api_key=[api_key]

Request parameters:

The XML Request should contain the parameters listed below:

Parameter  Type Description
from* Date Report start date. If not provided returns the report for the current server date. Example: &from=2016-04-02
to* Date Report end date. Example: &to=2016-04-08
segment* String Allowed values: hour dayplacement (corresponds to subid)
site_id (corresponds to feedid)
site_id:placement (allows to collect stats from sub IDs mapped to a separate feed ID)

Example: &segment=hour

output* string xml or json
api_key string Your API key

* – non-obligatory parameter

Example response:

<response>
<result>
<record>
<conversions>0</conversions>
<publisher_profit>15.266401853412</publisher_profit>
<bad_clicks>211</bad_clicks>
<bids>38521</bids>
<clicks>12530</clicks>
<requests>293764</requests>
<impressions>1291</impressions>
<total_conversions>0</total_conversions>
<name>2016-04-20</name>
<conversion_rate>0</conversion_rate>
<coverage>0.13113</coverage>
<bad_click_percent>1.656</bad_click_percent>
<ecpc>0.00122</ecpc>
<ecpm>0</ecpm>
<ecpa>0</ecpa>
<cvr_percent>0</cvr_percent>
<ctr_percent>0</ctr_percent>
</record>
</result>
<total>
<name>Total/</name>
<clicks>29121</clicks>
<conversion_rate>0</conversion_rate>
<total_conversions>0</total_conversions>
<requests>2973808</requests>
<conversions>0</conversions>
<bad_clicks>2796</bad_clicks>
<bids>410247</bids>
<coverage>0.13795</coverage>
<publisher_profit>75.87302963915</publisher_profit>
<bad_click_percent>8.76</bad_click_percent>
<ecpc>0.00261</ecpc>
<ecpm>0</ecpm>
<ecpa>0</ecpa>
<cvr_percent>0</cvr_percent>
<ctr_percent>0</ctr_percent>
</total>
</response>