Stat

Stat is data gathered during the monitoring process.

Stat Model

Field Type Description

expiryPeriod

Integer

Parameter used for data expiry. Defined in milliseconds.

groupKey

Integer, String

Key to group data packets and make server to process them in a strict sequence.

initiator

String

Actor that changed the payload.

lastPayload

Object

Previous payload data. When the stat is changed by either an agent or REST API, the system records previous payload in this field.

payload

Object

Any JSON-encoded data you wish the server to process and store.

period

Integer

Parameter used for data expiry. Defined in milliseconds.

This field is typical for checks made by Agent. It is not recommended to use this field for writing stats directly via REST API, use expiryPeriod instead.

timestamp

Integer

UNIX timestamp in ms.

Data expiry

The system sets the data expiry time as the sum of expiryPeriod and period parameters.

If the expiryPeriod parameter is absent, the system will use the server.default_result_timeout parameter of the server configuration instead.

If the period parameter is absent, its default value is 0.

All values above are defined in milliseconds.

This field is typical for checks made by Agent. It is not recommended to use this field for writing stats directly via REST API, use expiryPeriod instead.

Examples

Fully Qualified Stat

{
    "groupKey": "gk_893",
    "expiryPeriod": 60000,
    "payload": {
        "statusCode": 200
    },
    "timestamp": 1620719755782
}

Shortened Stat

All fields except payload are optional, so it’s possible to send shortened version of the stat:

{
    "statusCode": 200
}