iVdopia provides a reporting API to access data for applications on daily basis for integration with your reporting system.
Note 1: A day is defined by the GMT timezone
Note 2: Daily reports for the previous day are available by 5 AM GMT.
Note 3: The result format will be modified to include breakdown of numbers by ad formatNote 3: Send a note to support@ivdopia.com to request a secret token for your publisher account
Request Format
https://www.vdopia.com/reporting/reporting.php?token=<publisher_secret_token>&apikey=<app_or_site_key>&date=<date>
Required Parameters
| Parameter | Type | Description | | date | String | Date of report in YYYY-MM-DD format | | token | String | Publisher token provided by iVdopia for the exclusive use by a publisher. (This is a secret token known only to iVdopia and the publisher. ) |
Optional Parameters | Parameter | Type | Description | | apikey | String | Key to uniquely identify a single site or application. Typically used by your devlopers/programmers to enable advertising, it is available on your portal channel listing. If apikey is supplied then report will be available for that channel other the report will provide the data for all applications for a publisher. | | end-date | String | End date for reporting in YYYY-MM-DD format
In a single call, at most 31 days of data can be requested. Both date (first day) and end-date (last day) are included in the reporting.
| | reportDuration | String | Accepted values: 'summary'
If a summary report is requested then 'end-date' is a required parameter. One node is returned per api-key/adformat pair containing the total data for the dates requested. Both date (first day) and end-date (last day) are included in the summarization. |
The Response Object
The response object is generated by the reporting service.
{
“reports” : [
{
“apikey”: “apikey”,
“date": "2010-01-31”,
“adtype”: “preapp”,
“complete”: “true”,
“impressions”: “1029384”,
“clicks” : “5678”,
“revenue” : “123.45”
},
{
“apikey”: “apikey”,
“adtype”: “banner”,
“date": "2010-01-31”,
“complete”: “true”,
“impressions”: “10632”,
“clicks” : “5678”,
“revenue” : “23.5”
}
]
}
| Parameter | Type | Description | | reports
| Array | Node containing the array for the specified date | | apikey
| String | Application/site identifier (see above) | | date | String | Date of report requested | | complete | String | true/false. True means the reporting is complete for requested date and no more updates will occur. False means that the reporting is tentative and more updates might occur. | | clicks | Number | Total number of clicks per adtype, apikey, date | | impressions | Number | Total number of impressions per adtype, apikey, date | | revenue | Number | Total revenue per adtype, apikey, date. (In publisher currency) | | adtype | String | video/videobanner/banner/interstitial | | type | String | Only specified when reportDuration is 'summary' | | end-date | String | Only specified when the reportDuration is 'summary' |
Examplehttps://www.vdopia.com/reporting/reporting.php?token=4f8f47f8654358b36eb5290efbd15a50&apikey=e7d986573322736ab48d431ee77efbcf&date=2011-02-23
{ “reports” : [ { “apikey”: “e7d986573322736ab48d431ee77efbcf”, “date": "2010-01-31”, “adtype”: “video”, “complete”: “true”, “impressions”: “1029384”, “clicks” : “5678”, “revenue” : “123.45” }, { “apikey”: “ e7d986573322736ab48d431ee77efbcf”, “adtype”: “banner”, “date": "2010-01-31”, “complete”: “true”, “impressions”: “10632”, “clicks” : “5678”, “revenue” : “23.5” } ] }
To compute the total impressions for this channel, you need to add impressions from all the entries in the "reports" node for the same API key. The same needs to be done for clicks and revenue. If any of the entry you are adding has complete:"false" then the total that you arrive at will also be subject to updates.
Possible values of 'adtype': - "banner" - simple image banners
- "html" - animated banners
- "preapp" - video
- "inapp" - video
- "static" - banner ads served in place of videos/rich-media where video are not available
- "preinter" - interstitial
- "ininter" - interstitial
- "vdobanner" - miniVDO
- "leadervdo" - iPad miniVDO
- "" (empty string) - Can happen in rare cases -- please process and report to Vdopia if this occurs in any report.
|
|
