Nats display top stats
From TMM Wiki
Revision as of 16:37, 20 May 2011 by TMMStephenY (talk | contribs)
Applies to NATS 4.0.25 and greater.
nats_display_top_stats
Get the top statistics by demographics, site, program, tour, login, or adtool.
Alias: display_top_stats
Parameters
(Required parameters in bold)
| Parameter | Description | Possible Values | Default Value | Example |
|---|---|---|---|---|
| tpl | Template used to display output | Any valid template | The function_display_stats template | tpl="mytemplate" |
| reference_date | Start the period on this date | Any date | The current date | reference_date="1 January 2008" |
| period | Get statistics for this period | Any length of time | None. (See Notes section below) | period="month" |
| start | Get statistics starting with this date | Any date | None. (See Notes section below) | start="1 January 2008" |
| end | Get statistics ending with this date | Any date | None. (See Notes section below) | end="31 December 2008" |
| field | Class of statistics to get | Any statistics type: site, program, demographics, login, adtool | Site. Gets statistics for the affiliate's referrals to sites | field="program" |
| order | The sort order | Any sort field | ? | ? |
| assign_prefix | Prefix output variables with this word. (Click link for details) | Any valid Smarty variable name | None. (No prefix is used) | assign_prefix="myvar" |
| data_only | Set variables but don't display the template | 1 | None. The template is displayed. | data_only=1 |
Output
A form displaying an affiliate's top statistics for a single class of referrals.
Output placed in an array. The array's name contains the value of the the type parameter. For example: if you set the type parameter to "site", the array name will be top_site_stats. If you set the type parameter to "program", the array name will be top_program_stats.
Notes
If the parameters, period, start, and end are not set, this function gets the top statistics for today.
See Also
- nats_display_stats -- Displays detailed affiliate statistics.
- NATS4 Affiliate Stats -- Default NATS4 affiliate template using this template function
- PHP Manual: strtotime -- PHP function used to parse dates
