Interface StatsParams

The StatsParams interface describes the parameters accepted by the following methods:

Hierarchy

  • StatsParams

Properties

direction end limit start unit

Properties

Optional direction

direction?: "forwards" | "backwards"

The order for which stats are returned in. Valid values are 'backwards' which orders stats from most recent to oldest, or 'forwards' which orders stats from oldest to most recent. The default is 'backwards'.

Default Value

'backwards'

Optional end

end?: number

The time until stats are retrieved, specified as milliseconds since the Unix epoch.

Default Value

The current time.

Optional limit

limit?: number

An upper limit on the number of stats returned. The default is 100, and the maximum is 1000.

Default Value

100

Optional start

start?: number

The time from which stats are retrieved, specified as milliseconds since the Unix epoch.

Default Value

The Unix epoch.

Optional unit

unit?: StatsIntervalGranularity

Based on the unit selected, the given start or end times are rounded down to the start of the relevant interval depending on the unit granularity of the query.

Default Value

StatsIntervalGranularity.MINUTE

Settings

Member Visibility

Theme

Generated using TypeDoc