System Statistics

System Statistics

This resource represents system statistics.


Get system statistics

This is only available for Support Admins

Request

Query parameters

If both MinDateTime and MaxDateTime are omitted, only the latest record is retrieved.

Parameters

Type

Notes

Parameters

Type

Notes

Types

string (comma delimited list)

Comma delimited list of specific statistic types. When requesting multiple types, the records will be returned in type groups.

MinDateTime

string

Start date/time.

MaxDateTime

string

End date/time.

Interval

integer

Number of seconds.

Do not include to leave returned data as original recorded period.  If specifying custom interval, the return data will be aggregated to best meet the requested interval.  For example with data collected every 10 seconds and a requested interval of 60 seconds, then each returned data structure will be comprised of combining 6 data points.  If requesting too small of an interval then the data will be returned as original with actual duration.

Do not include MinDateTime and MaxDateTime in order to get latest record.  Otherwise set MinDateTime and MaxDateTime to the desired range.  If desiring oldest records up to certain point, leave out MinDateTime and only set MaxDateTime.  Alternatively if desiring newest records from a certain point, leave out MaxDateTime and only set MinDateTime.

Field Name

Type

Description

Notes

Field Name

Type

Description

Notes

Types

int

Comma delimited list of desired statistical types

(Can combine one or more types)

Refer to listing for all types and descriptions

Start

DateTime

Start time of period (UTC)

 

Duration

float

Period duration in seconds

 

Value

float

Statistical value

 

GET /api/SysStats