StatResult

The StatResult action returns the results of the configured statistics in XML format.

Parameters

The StatResult action supports the following parameters.

Name

Restrict results to the specified statistics. The statistics that you enter must exist in the Statistics Server configuration file. Separate multiple entries with commas.

Type: String
Default: None
Required: No
Example: Name=count_queries_hour,count_queries_day

DateString

Set the timestamp format. Set this parameter to True to display the timestamp in human-readable format (DD/MM/YYYY HH:MM:SS), or False to display it in epoch time.

Type: Boolean
Default: False
Required: No
Example: DateString=True

DynamicValue

The value of the dynamic field. If the field specified in the Name parameter is a dynamic field, specify the value of this field for which you want to return results.

Type: String
Default: None
Required: No
Example: DynamicValue=London

From

Set a minimum timestamp value. Statistical results must have a timestamp of equal or greater value to be returned.

NOTE:

The format in which you must enter a value depends on the DateString parameter setting. If it is False, you must enter an epoch time value. If it is True, you must enter a human-readable format value.

Type: String
Default: 0 (disabled)
Required: No
Example: From=1220433495
See also:

DateString

UpTo

UpTo

Set a maximum timestamp value. Statistical results must have a timestamp of equal or lesser value to be returned.

NOTE:

The format in which you must enter a value depends on the DateString parameter setting. If it is False, you must enter the an epoch time value. If it is True, you must enter a human-readable format value.

Type: String
Default: 0 (disabled)
Required: No
Example: UpTo=1220433505
See also:

DateString

From

MaxResults

Return the last N statistical results.

Type:

Integer

Default:

0 (disabled)

Required:

No

Example:

MaxResults=10

MaxValues

Return only the top N values for a TopN or CumulativeTopN statistic.

Alternatively, set MaxValues to 0 to return only the number of unique values for TopN or CumulativeTopN statistics, without returning the values.

Type:

Integer

Default:

All values are shown

Required:

No

Example:

MaxValues=10

Example

action=StatResult&Name=stat1,stat2&MaxResults=25

In this example, Statistics Server returns the most recent 25 results of the stat1 and stat2 statistics.


_HP_HTML5_bannerTitle.htm