Nats display stats form
From TMM Wiki
Jump to navigationJump to searchThe printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.
Applies to NATS 4.0.25 and greater.
nats_display_stats_form
Display a form to the affiliate for selecting stats by site, program, campaign, and date.
Alias: display_stats_form
Parameters
(Required parameters in bold)
Parameter | Description | Possible Values | Default Value | Example |
---|---|---|---|---|
period | Display stats for this period | 0 thorough 8; see Notes section below | 0 | period="8" |
start | The period's start date | Any date | Start of the current period | start="1 January 2008" |
end | The period's end date | Any date | End of current period | end="26 August 2008" |
assign_prefix | Prefix output variables with this word. (Click link for details) | Any valid Smarty variable name | None. (No prefix is used) | assign_prefix="my VAR" |
data_only | Set variables but don't display the template | 1 | None. The template is displayed. | data_only=1 |
Output
A form with fields for selecting sites, programs, and campaigns. Also outputs the following variables:
- period_start
- period_end
- view_title
- countries
- country_iso
Notes
The period parameter, described above, takes a single numeric argument. The table below describes the valid arguments.
# | Description |
---|---|
0 | This Period |
1 | Last Period |
2 | Today |
3 | Yesterday |
4 | This Week |
5 | This Month |
6 | This Year |
7 | All Time |
8 | Freeform |
See Also
- nats_display_stats -- Displays statistics based on above criteria.