Retrieve Report By Zone Id

From wiki.taptica.com
(Difference between revisions)
Jump to: navigation, search
(End Point)
(Retrieve Report By Zone Id)
Line 5: Line 5:
  
 
== Retrieve Report By Zone Id ==
 
== Retrieve Report By Zone Id ==
 +
Taptica Data API design to give Taptica clients a B2B solution for retrieving its’ data structure (client account structure) as well as its operation statistical data.
  
This method is used to send request to Taptica's Core servers for retrieving ads reports.
+
Taptica support 2 reports APIs
The method will pass to Taptica's Core servers unique IDs identifying the Zone Id and a set of metadata describing the request.
+
 
 +
1. '''Get App'''
 +
  Account static structure data – give the account its’ affiliates and apps.
 +
 
 +
2. '''Get Stats'''
 +
  Account affiliate statistical data – give statistical data for time frame
  
 
== End Point ==
 
== End Point ==

Revision as of 07:56, 9 July 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

Taptica Data API design to give Taptica clients a B2B solution for retrieving its’ data structure (client account structure) as well as its operation statistical data.

Taptica support 2 reports APIs

1. Get App

  Account static structure data – give the account its’ affiliates and apps.

2. Get Stats

  Account affiliate statistical data – give statistical data for time frame

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=SomeToken&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.
byOffer By Offer, if byOffer=false an aggregate report will be created
from Date , start date to begin the report. (format:YYYYMMDD or YYYY-MM-DD)
to Date , end date to end the report. (format:YYYYMMDD or YYYY-MM-DD)
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>
      <date>2013-01-30</date>
      <offerid>2080</offerid>
      <request>113524</request>
      <impression>31123</impression>
      <clicks>209</clicks>
      <conversions>1</conversions>
      <cr>0.478</cr>
      <fillrate>27.415</fillrate>
      <cost>2.00000</cost>
      <cpc>0.010</cpc>
      <ctr>0.672</ctr>
      <profit>-0.50000</profit>
      <revenue>1.50000</revenue>
      <rpc>0.007</rpc>
    </item>
  </data>
</response>

XML Error Example

<?xml version="1.0"?>
<response>
 <data i:nil="true"/>
 <error>
  unknown zoneid=7c2bfe27-6262-4942-b4e-660fa0f95bd1
 </error>
</response>

JSON

{ 
 "reports":[
 {
   "date":"2013-01-30",
   "requests":4072698,
   "impressions":4000034,
   "offerid":0,
   "fillrate":0.98,
   "clicks":14446,
   "ctr":0.463,
   "revenue":99.0,
   "conversions":1600,
   "cr":0.5,
   "cost":132.0,
   "cpc":0.0091,
   "rpc":0.0068,
   "profit":123343.00
 }]
}

JSON Error:

{"reports":null,"error":"Unknown zoneid=7c2bfe27-6262-4942-b4e-660fa0f95bd1"}


CSV

Date,OfferId,Requests,Impressions,Clicks,Conversions,CR,FillRate,Cost,CPC,CTR,Profit,Revenue,RPC
2013-01-30, 4072698, 3118472, 76.57, 14446, 0.463, 66, 0.456, 132.00, 0.00913, 0.0068531, 23433.00,99.00

CSV Error Example:

Unknown zoneid=7c2bfe27-6262-4942-b4e-660fa0f95bd1
Personal tools
Namespaces

Variants
Actions
Navigation
Toolbox