Retrieve Report By Zone Id
From wiki.taptica.com
(Difference between revisions)
(→End Point) |
(→End Point) |
||
| Line 15: | Line 15: | ||
A simple HTTP GET request of the form: | A simple HTTP GET request of the form: | ||
| − | http://api.reports.taptica.com/v2/data?zoneid=ABC&token= | + | http://api.reports.taptica.com/v2/data?zoneid=ABC&token=[to be provided by Taptica]&from=20130120&to=20130122&format=json |
'''Parameters Description'''<br/> | '''Parameters Description'''<br/> | ||
Revision as of 14:44, 5 February 2013
Audience
This document is intended for software engineers, product or project managers responsible for the implementation of Taptica's API for reports.
Retrieve Report By Zone Id
This method is used to send request to Taptica's Core servers for retrieving ads reports. The method will pass to Taptica's Core servers unique IDs identifying the Zone Id and a set of metadata describing the request.
End Point
Ad requests to the Taptica's API comprise:
A simple HTTP GET request of the form:
http://api.reports.taptica.com/v2/data?zoneid=ABC&token=[to be provided by Taptica]&from=20130120&to=20130122&format=json
Parameters Description
| Parameter | Description |
| token | Authentication token provided by Taptica's Core |
| zoneid | Zone Id as provisioned by Taptica's Core. |
| from | Date , start date to begin the report. (format:YYYYMMDD) |
| to | Type: Date , end date to end the report. (format:YYYYMMDD) |
| format | xml, json or csv responses.
|
Return Value
XML, JSON or CSV dependent on the format value, default value XML
Reporting Examples
XML
<?xml version="1.0"?>
<response>
<data>
<Item>
<CPC>0</CPC>
<CTR>0</CTR>
<Clicks>0</Clicks>
<ConversionRate>0</ConversionRate>
<Conversions>0</Conversions>
<Cost>91.00000</Cost>
<Date>2013-01-31T00:00:00</Date>
<FillRate>0</FillRate>
<Impressions>0</Impressions>
<Profit>39.00000</Profit>
<RPC>0</RPC>
<Requests>0</Requests>
<Revenue>130.00000</Revenue>
<ZoneId>ABC</ZoneId>
</Item>
</data>
</response>
