stat-query

stat-query
stat-query

Object used to request stats(metrics) on a collection of resources.
Defines search criteria as well as expected data set.

JSON Example
{
    "resourceId": [
        "string"
    ],
    "statKey": [
        "string"
    ],
    "begin": 0,
    "end": 0,
    "rollUpType": "string",
    "intervalType": "string",
    "intervalQuantifier": 0,
    "dt": false,
    "latestMaxSamples": 0,
    "metrics": false,
    "currentOnly": false,
    "wrapStatValues": false
}
array of string
resourceId
Optional

Array of Resource ids for which the stats should be fetched

array of string
statKey
Optional

Array of stat keys for which the stats should be returned

integer As int64 As int64
begin
Optional

The beginning date as a long value of the range of stats to return
Value measures the number of milliseconds since January 1, 1970 00:00:00 UTC
NOTE: If not provided, 24 hour rearward of ending date is used

integer As int64 As int64
end
Optional

The ending date as a long value of the range of stats to return
Long value is number of milliseconds since January 1, 1970 00:00:00 UTC
NOTE: The ending date must not be less than the beginning date.
If not provided, current time as UTC milliseconds is used

RollUpType
rollUpType
Optional

Represents the type of Rollup required for the stats data

Possible values are : SUM, AVG, MIN, MAX, NONE, LATEST, COUNT,
IntervalType
intervalType
Optional

The Interval types

Possible values are : HOURS, MINUTES, SECONDS, DAYS, WEEKS, MONTHS, YEARS,
integer As int32 As int32
intervalQuantifier
Optional
Constraints: minimum: 1

Number for the interval type

boolean
dt
Optional

Indicates that the requested stats are based on some dynamic threshold.
Defaults to false which indicates that stats are not based on dynamic threshold.

integer As int32 As int32
latestMaxSamples
Optional

The maximum number of samples to return when querying latest.
When processing the get latest stats query if it is omitted a value of 1 is assumed.
A query for the latest samples is not compatible with specifying the RollUpType value.

boolean
metrics
Optional

Indicates whether specified statKey-s of query should be forcibly treated as metrics (does not include instanced stats)

boolean
currentOnly
Optional

Indicates whether to report only "current" stat values, i.e. skip the stat-s that haven't published any value
during recent collection cycles.

boolean
wrapStatValues
Optional

Indicates whether stat values should be wrapped for application/xml response content type.
This flag is false by default and not needed for application/json response.
If set to true "statValues" will be returned instead of "values" for all content types.

Parameter To