nats_display_stats

Displays affiliate statistics.

Article Topics: Customization, Templates

Alias: display_stats

Parameters

Parameter	Description	Possible Values	Default Value	Example
tpl	Template used to display output	Any valid template	The template, function_display_top_stats	tpl="mytemplate"
assign_prefix	Prefix output variables with this word (see Output section below)	Any valid Smarty variable name	Empty	assign_prefix="mystats"
breakdown	Show stats by these categories	See list of categories in Notes section below. Can be a comma-separated list of categories	Date. Shows only stats by date	breakdown="camp"
period	Show stats for this period	See list of periods in Notes section below.	Current. Shows stats for current period	period="all"
start	Start date for freeform period. (See period parameter above)	Any date	Yesterday. Starts with yesterday's stats	start="1 January 2008"
end	End date for freeform period. (See period parameter above)	Any date	Now. Ends with present stats	end="26 August 2008"
no_form_vars	Does not use parameters set by the user in a form	0 or 1	0. Uses form parameters	no_form_vars="1"
no_hits	Don't report hits in output	0 or 1	0. Reports hits	no_hits="1"
no_transactions	Don't report transactions in output	0 or 1	0. Reports transactions	no_transactions="1"
no_referral	Don't report referrals in output	0 or 1	0. Reports referrals	no_referral="1"
order	What order to output stats	?	breakdown ASC	?
reference_date	?	1	0	reference_date="1"
data_only	Set variables but don't display the template	1	None. The template is displayed.	data_only=1

Output

Outputs a list of statistics formatted by the parameter of the tpl argument. Also stores output in the variables or arrays listed below; variables are prefixed with the argument of the assign_prefix parameter.

• .breaks

• .stats

• .total

• .breakdown

• .current_period

• .filters

• .period_start

• .period_end

The following three variables are not prefixed with assign_prefix:

• period_options

• countries

• country_iso

Notes

The arguments for the parameter breakdown, described above, can either be of numbers or names. The table below lists the numbers, names and argument descriptions.

#	Name	Argument Description
0	date	Current Date
1	camp	Campaign
2	prog	Program
3	site	Site
4	tour	Tour
5	option	Option
6	adtool	Adtool
7	subid1	Sub ID #1
8	subid2	Sub ID #2
9	biller	Biller
10	country	Country
11	week	Week
12	period	Period
13	month	Month
14	year	Year

The arguments for the parameter period, described above, can either be a number, a name, or a list of numbers or names. The table below lists the numbers, names, and argument descriptions.

#	Name	Argument Description
0	current	Current Period
1	last	Last Period
2	today	Today
3	yesterday	Yesterday
4	week	This Week
5	month	This Month
6	year	This Year
7	all	All Time
8	free	Freeform (See also the start and end parameters above)

See Also

• nats_display_stats_calender -- displays a calendar that links to daily statistics