Alerts

Get an alert by ID

get/api/v2/alerts/{alertID}

Request

  • Base URL: https://gear.cloud.studio
  • URL: https://gear.cloud.studio/api/v2/alerts/{alertID}
  • Auth: one of:
    • HTTP bearer
    • API key in query parameter accessToken

Path parameters

alertIDinteger required

Unique identifier of the alert.

Response

The alert.

AlertIDinteger
VariableTypeIDinteger

Variable the alert watches. User-defined variables are 1000 or higher. Predefined: 1 temperature, 2 humidity, 3 light level, 4 setpoint, 5 volume, 6 active energy, 7 run time, 8 discrete sensor state, 9 dimmerization, 10 weight, 11 flow, 12 voltage, 13 current, 14 active power, 15 reactive power, 16 apparent power, 17 power factor, 18 pressure, 19 frequency, 20 ppm concentration, 21 mass/volume concentration, 22 AQI, 23 people flow, 24 people count, 25 reactive energy, 26 apparent energy, 27 location.

EndpointIDinteger
FacilityIDinteger
ClientIDinteger
ConditionType1 | 2 | 3 | 4 | 5 | 6

1 equal, 2 not equal, 3 greater, 4 greater or equal, 5 lower, 6 lower or equal.

Thresholdnumber double

Value compared with ConditionType to trigger the alert.

NormalConditionType1 | 2 | 3 | 4 | 5 | 6

1 equal, 2 not equal, 3 greater, 4 greater or equal, 5 lower, 6 lower or equal.

NormalThresholdnumber double

Value compared with NormalConditionType to close the alert.

MinimumDurationSecondsinteger

Seconds the condition must hold before the alert triggers.

NotificationEmailsstring[]
NotificationSMSNumbersstring[]
NotificationVoiceNumbersstring[]
Tagsstring[]
SequenceNumberinteger
Enabledboolean

False when the alert was deleted. Deleted alerts only appear in the incremental list.

Changes

No recorded changes to this operation across all 1 revision of this API.