Subscription

Subscription data type description

A subscription is an entity that belongs to a user. It correspond to a link between a User and a Metric with the following meaning: "This user is tracking this metric, if the metric has high variations, the user will receive an alert".

A Subscription contains the following fields:

NameTypeDescription

id

string

Id of the subscription

userId

string

Id of the user

metricKey

string

Key of the Metric

threshold

number

The threshold associated to the subscription. The threshold unit is defined in % (threshold=50 means 50%). For a subscription with a threshold of 50%, it means that if the metric changes by more than 50% (increase or decrease), an alert will be triggered.

startWindowTimestamp

number

UNIX timestamp used to process alerts. When a new data point appears on a metric you follow, the system checks highest variation between range [currentTimestamp-startWindowTimestamp

,currentTimestamp]

Last updated