# nats\_display\_top\_stats

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](https://docs.toomuchmedia.com/nats-admin/skins-and-templates/further-reading/template-function-parameters/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](https://docs.toomuchmedia.com/nats-admin/skins-and-templates/further-reading/template-function-parameters/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](https://docs.toomuchmedia.com/nats-admin/skins-and-templates/further-reading/template-functions/nats_display_stats) -- Displays detailed affiliate statistics.
* [NATS Affiliate Stats](https://docs.toomuchmedia.com/affiliate-area/affiliate-area/statistics/affiliate-statistic-views) -- Default NATS affiliate template using this template function
* [PHP Manual: strtotime](http://us.php.net/manual/en/function.strtotime.php) -- PHP function used to parse dates