Reporting API V2

Analytics API

This API call shows the amount of commissions made during a certain period of time.

http://account.yieldkit.com/v2/report/revenue[?parameters]

Revenue

http://account.yieldkit.com/v2/report/revenue?
api_key=<api_key>&
api_secret=<api_secret>&
report_name=<report_name>&
interval=day&
reference_date=<date>&
delta=<time_difference>&
format=<file_format_output>

PARAMETERS:

Parameter	Description
Mandatory fields
api_key	Find your API Key in http://www.yieldkit.com/account API Access
api_secret	Find your API Secret in http://www.yieldkit.com/account API Access
report_name	date,site,page,browser,browser_version,country,device_type,language,os,sub_id,commission
format	xlsx, gchart, json, csv (default)
reference_date	Date of the report (YYYY-MM-DD)
delta	Delta time for the report given by (day,week,month,year) units. ie, -10day
Optional fields
interval	day
start_date	Start date of the report (YYYY-MM-DD)
end_date	End date of the report (YYYY-MM-DD)
limit	Number of results that want to be retrieved
site_id	Find your Site ID in http://www.yieldkit.com/account under Your Sites tab
currency	By default is EUR but it’s possible to make other currency conversions.
date_type	By sales date or modified date
date_format	It is possible to set date and time patterns. More info: https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html
product	YieldKit product that generated commissions can be YieldLink, YieldWord, YieldWidget, YieldShare, YieldNative and YieldSearch.

NB. Although the parameters reference_date and delta are mandatory, these can be replaced by start_date and end_date

SOME EXAMPLES

Date report

http://account.yieldkit.com/v2/report/revenue?
                    api_key=<api_key>&
                    api_secret=<api_secret>report_name=date&
                    interval=day&
                    reference_date=now&
                    delta=-4day&
                    format=csv

Response

"Date","Ad Impressions","Clicks","Sales","CTR %","CR %","EPC","Revenue"
                    "2014-06-21","123","0","0","0.0","0.0","0.0","0.0"
                    "2014-06-22","127","2","0","0.44","0.0","0.0","0.0"
                    "2014-06-23","135","0","0","0.0","0.0","0.0","0.0"
                    "2014-06-24","319","0","0","0.0","0.0","0.0","0.0"

Site report

http://account.yieldkit.com/v2/report/revenue?
                    api_key=<api_key>&
                    api_secret=<api_secret>report_name=site&
                    interval=day&
                    reference_date=now&
                    delta=-1week&
                    format=csv

Response

"site","Ad Impressions","Clicks","Sales","CTR %","CR %","EPC","Revenue"
                    "blog.de","56","1","0","0.3","0.0","0.0","0.0"
                    "test.de","31","0","0","0.0","0.0","0.0","0.0"
                    "publisher.de","9","0","0","0.0","0.0","0.0","0.0"
                    "weltbild.de","2","0","0","0.0","0.0","0.0","0.0"
                    "pcwelt.de","377","0","0","0.0","0.0","0.0","0.0"
                    "sameple.com,"22","0","0","0.0","0.0","0.0","0.0"
                    "blogging.co.uk","6","0","0","0.0","0.0","0.0","0.0"

Browser report

http://account.yieldkit.com/v2/report/revenue?
                    api_key=<api_key>&
                    api_secret=<api_secret>report_name=browser&
                    interval=day&
                    reference_date=2014-05-10&
                    delta=-2week&
                    format=csv

Response

"Browser","Ad Impressions","Clicks","Sales","CTR %","CR %","EPC","Revenue"
                    "Chrome","1422","0","0","0.0","0.0","0.0","0.0"
                    "Internet Explorer","1","0","0","0.0","0.0","0.0","0.0"
                    "Mozilla","332","0","0","0.0","0.0","0.0","0.0"
                    "Firefox","1123","4","0","0.18","0.0","0.0","0.0"

Criterion report

http://account.yieldkit.com/v2/report/revenue?
                    api_key=<api_key>&
                    api_secret=<api_secret>report_name=criterion_id&
                    interval=day&
                    reference_date=2014-05-10&
                    delta=-1day&
                    format=csv&
                    limit=10

Response

"Criterion ID","Ad Impressions","Clicks","Sales","CTR %","CR %","EPC","Revenue"
                    "Iphone 5","301","1","0","33.33","0.0","0.0","0.0"
                    "Musik","11","0","0","0.0","0.0","0.0","0.0"
                    "COMPUTER","167","0","0","0.0","0.0","0.0","0.0"
                    "SPIELE","89","0","0","0.0","0.0","0.0","0.0"
                    "Galaxy S","71","0","0","0.0","0.0","0.0","0.0"
                    "camera","12","0","0","0.0","0.0","0.0","0.0"
                    "Handy","24","0","0","0.0","0.0","0.0","0.0"
                    "Notebook","55","0","0","0.0","0.0","0.0","0.0"
                    "CD","31","0","0","0.0","0.0","0.0","0.0"
                    "PC","45","0","0","0.0","0.0","0.0","0.0"