Report API V1

The Report Service provides detailed information on affinitAD solutions performance and monetisation.

1. Version

Current version is :
v2.42.0

2. Access

Product API access point :
http://[publicKey]:[APIKey]@api.affinitad.com/report/v1

3. API Call

Here is a list of parameters:

Parameter Mandatory Description
start Yes reporting request start date, date format should be as follows YYYY-MM-DD
end Yes reporting request end date, date format should be as follows YYYY-MM-DD
domain No Filter results for one or several domains : List from 1 to 1024 characters with comma-seperated values.
subid No Filter results for one or several subid : List from 1 to 1024 characters with comma-seperated values
channel No Filter results for one or several channels : List from 1 to 1024 characters with comma-seperated values
group Yes Group Data by a value to be selected among the following options {'day', 'domain', 'subid', 'channel', 'day_domain' , 'product' , 'geozone'}. Each result will be associated with the corresponding tag.
format Yes Response format to be selected among the following options {'xml', 'json', 'jsonp'}. ‘jsonp’ should be used with jsonp_callback parameter
jsonp_callback Yes if format=’jsonp’ Name of the callback function.
product No The product ID for which you wish to see the stats. NB: You can get your products ID’s by grouping first on products (&group=product).
geozone No The geozone for which you wish to see the stats. Expected values are the 2-letter ISO 3166-1 Country Codes. Currently allowed values are :
  • FR for France
  • GB for United Kingdom
  • IT for Italy
  • DE for Germany
  • NL for the Netherlands

JSON XML

{
"results": {
"@attributes": {
"total": "91"
},
"result": [{
"date": "2010-03-31",
"impressions": "146",
"clicks": "48",
"keywords": "47",
"revenues": "34.4",
"ctr": "0.33",
"ecpc": "0.72",
"ecpm": "235.62"
},
...]
},
"totals": {
"impressions": "17624",
"clicks": "3776",
"keywords": "3737",
"revenues": "3534.77"
},
"averages": {
"impressions": "193.67",
"clicks": "41.49",
"keywords": "41.07",
"revenues": "38.84",
"ctr": "0.21",
"ecpc": "0.94",
"ecpm": "200.57"
}
}

<?xml version="1.0" encoding="UTF-8"?>
<twenga>
<results total="91">
<result>
<date>2010-04-01</date>
<impressions>185</impressions>
<clicks>32</clicks>
<keywords>47</keywords>
<revenues>53.47</revenues>
<ctr>0.17</ctr>
<ecpc>1.67</ecpc>
<ecpm>289.03</ecpm>
</result>
...
</results>
<totals>
<impressions>17624</impressions>
<clicks>3776</clicks>
<keywords>3737</keywords>
<revenues>3534.77</revenues>
</totals>
<averages>
<impressions>193.67</impressions>
<clicks>41.49</clicks>
<keywords>41.07</keywords>
<revenues>38.84</revenues>
<ctr>0.21</ctr>
<ecpc>0.94</ecpc>
<ecpm>200.57</ecpm>
</averages>
</twenga>