Reporting

Description

Provides a reporting on a given period, several reporting types and languages are available

URL(s)

https://apiv2.effiliation.com/apiv2/reporting.xml?key=YOUR_API_KEY
https://apiv2.effiliation.com/apiv2/reporting.csv?key=YOUR_API_KEY
https://apiv2.effiliation.com/apiv2/reporting.json?key=YOUR_API_KEY

Parameters

Parameter	Format	Description	Example value
key	String	Publisher api key	YOUR_API_KEY
lg	String	Output language	fr, en, es, it, pt, de, nl
type	String	Reporting type, program: by program, link: by link, linktype: by link type; theme: by theme, day: by day, week: by week, month: by month	program
start	String	Begin date	01/01/2013
end	String	End date	31/01/2013
fields	String	Fields displayed in the output(0: not displayed, 1: displayed)	01100110

Returned fields

Use fields selector to choose the fields you need. Eg: fields=00101.

	Field	Description	Type
	id	Reporting Id	String
	id_programme	ProgramId	Integer
	id_session	Session Id	Integer
	id_affilieur	Advertiser Id	Integer
	level1	Reporting type	String
	level2		String
	affichage	Displays	Integer
	affichageu	Uniques displays	Integer
	clic	Clics	Integer
	clicm	Uniques clics	Integer
	percentclic	% of clic	Decimal
	percentclicm	% of unique clic	Decimal
	doubleclic	Double clics	Integer
	doubleclicm	Uniques double clics	Integer
	lead	Leads	Integer
	leadpc	Leads post-clic	Integer
	leadpi	Leads post-view	Integer
	leadrefuse	Refused leads	Integer
	leadpcrefuse	Refused post-clic leads	Integer
	leadpirefuse	Refused post-view leads	Integer
	revenue	Sells	Integer
	revenuepc	Post-clic sells	Integer
	revenuepi	Post-view sells	Integer
	revenuerefuse	Refused sells	Integer
	revenuepcrefuse	Post-clic refused sells	Integer
	revenuepirefuse	Post-view refused sells	Integer
	leadperclic	% of lead per clic	Decimal
	revenueperclic	% of sell per clic	Decimal
	ca	Sales	Decimal
	capc	Post-clic sales	Decimal
	capi	Post-view sales	Decimal
	carefuse	Refused sales	Decimal
	averageorder	Average amount of order	Decimal
	montant	Commissions without reguls	Decimal
	lead2	Lead custom indicator 2	Integer
	lead3	Lead custom indicator 3	Integer
	lead4	Lead custom indicator 4	Integer
	lead5	Lead custom indicator 5	Integer
	leadpi2	Lead post-view custom indicator 2	Integer
	leadpi3	Lead post-view custom indicator 3	Integer
	leadpi4	Lead post-view custom indicator 4	Integer
	leadpi5	Lead post-view custom indicator 5	Integer
	revenue2	Sell custom indicator 2	Decimal
	revenue3	Sell custom indicator 3	Decimal
	revenue4	Sell custom indicator 4	Decimal
	revenue5	Sell custom indicator 5	Decimal
	revenuepi2	Post-view sell custom indicator 2	Decimal
	revenuepi3	Post-view sell custom indicator 3	Decimal
	revenuepi4	Post-view sell custom indicator 4	Decimal
	revenuepi5	Post-view sell custom indicator 5	Decimal
	leadindirect	Indirect leads	Integer
	revenueindirect	Indirect sells	Integer
	caindirect	Indirect sales	Decimal
	percentleadpc	% of post-clic lead	Decimal
	percentleadpi	% of post-view lead	Decimal
	percentrevenuepc	% of post-clic sell	Decimal
	percentrevenuepi	% of post-view sell	Decimal
	percentleadrefuse	% of refused lead	Decimal
	percentrevenuerefuse	% of refused sell	Decimal
	percentcarefuse	% of refused sales	Decimal
	percentleadpcrefuse	% of refused post-clic lead	Decimal
	percentleadpirefuse	% of refused post-view lead	Decimal
	percentrevenuepcrefuse	% of refused post-clic sell	Decimal
	percentrevenuepirefuse	% of refused post-view sell	Decimal
	capcrefuse	% of refused post-clic sales	Decimal
	capirefuse	% of refused post-view sales	Decimal
	epc	Earn percent	Decimal
	ecpm	Cost for 1000 displays	Decimal
	ajout	Amount of commission added manually	Decimal
	challenge		Decimal
	mingar	Minimum of commission you get	Decimal
	quota	Maximum of commission you get	Decimal
	peaksell	Amount of commission added manually for ads publishers	Decimal
	compot		Decimal

Examples

Reporting by program, month 09/2013, in french

https://apiv2.effiliation.com/apiv2/reporting.xml?key=YOUR_API_KEY&type=program&start=01/09/2013&end=30/09/2013&lg=fr

Reporting by link, month 09/2013, in english

https://apiv2.effiliation.com/apiv2/reporting.csv?key=YOUR_API_KEY&type=link&start=01/09/2013&end=30/09/2013&lg=en

Reporting by link, month 09/2013, in english with only id_programme and id_session

https://apiv2.effiliation.com/apiv2/reporting.json?key=YOUR_API_KEY&type=link&start=01/09/2013&end=30/09/2013&lg=en&fields=011