Get Triggered Alerts

This guide will show you how you can view triggered Alerts. Please note that triggered Alerts are called Alarms.

Get Triggered Alerts

GET https://console.monogoto.io/alarms

Headers

Name	Type	Description
YOUR_TOKEN*	String	Your authentication token
CUSTOMER_ID	String	Customer API key

200: OK OK

[
  {
    "ActionResults": [],
    "Alert": {
      "ActionBlockIncommingActive": false,
      "ActionClearDeviceActive": false,
      "ActionSendSmsToThingActive": false,
      "ActionSuspendActive": false,
      "ActionWebhookActive": false,
      "AlertActive": true,
      "AlertDescription": "Last usage test",
      "AlertId": "AlertId_1944f02cv-6bb5-5008-a12e-b11e0e2c181d",
      "AlertName": "Last usage alert",
      "CustomerId": "cid_ecs1d3a5-f5e62a1-fe8af468wf",
      "DateCreated": 1611912330167,
      "DateModified": 1611912330169,
      "MetricType": "Last_Usage",
      "MetricValue": 1,
      "Operation": ">=",
      "OverrideOrMultiple": "Override",
      "Severity": "Info",
      "ThingTags": [],
      "ThingsGroup": [
        "ThingsGroupId_b7786b88-e651-4997-8bh6-dfd4hh32b417",
        "ThingsGroupId_ff6421c0-bff0-4997-93abc768ee6ca9b017a"
      ],
      "Type": "AlertId"
    },
    "CellId": 12345,
    "CustomerId": "cid_ecs1d3a5-f5e62a1-fe8af468wf",
    "DateCreated": 1612095568940,
    "DateModified": 1612095568942,
    "FiredAlertDescription": "Last usage test",
    "Lac": 54321,
    "LastLocationUpdateTime": "2020-10-23 07:21:39",
    "Latitude": 12.34567,
    "Longitude": 23.45678,
    "Owner": "Demo Administrator",
    "Status": "Active",
    "TelephonyProfileId": "TelephonyProfile_ad766b40-9667-4ff1-9a79-0169467834d9",
    "TelephonyProfileName": "Default telephony profile",
    "Thing": {
      "ActivationChargeFlag": false,
      "ActiveMobileSubscriber": "123456789101112",
      "AddressSignal": "370611111111",
      "BatchId": "tutorial SIM",
      "Block": {
        "Data": false
      },
  
  ...

401 Unauthorized

{
    // Response
}

404: Not Found Not found

{
    // Response
}

To receive triggered Alerts (Alarms) list, please use following request:

curl -X GET \
    --url "https://console.monogoto.io/alarms/" \
    -H "accept: application/json" \
    -H "Authorization: Bearer {TOKEN_HERE}" \
    -H "apikey: {CUSTOMER_ID}"

Add your Token and Customer ID in the GET request to successfully obtain the Thing info.

Request example:

curl -X GET \
    --url "https://console.monogoto.io/alarms/" \
    -H "accept: application/json" \
    -H "Authorization: Bearer eyJhb6IkpXVCJ9.eyJSb2xlIjoiVXN4lclByb2ZpbGVJZF9kZGM2MThhNC0wNTI1LTQ2MmUtYWN3NzhhMGQxYmbSI6Im4zgFkbWluIiwiQ3VzdG9tsbCwiVXNlcklkIjoiVklkXzg5Yj5Y2OGEyUtNDQThhLTEzZjA0MzJhZDE3YyINTAzgZmUtZGI51My00ZjRiLTktN2U5Yjc0ZWU1ZThlIiwiaWNzM3MjI5L2MDY3NTE2Mjl9.99aSLzP7kTgK6TZGW-xalrMu0GkW6viunt3XxbNng" \
    -H "apikey: cid_ecs1d3a5-f5e62a1-fe8af468wf"

Expected result:

[
  {
    "ActionResults": [],
    "Alert": {
      "ActionBlockIncommingActive": false,
      "ActionClearDeviceActive": false,
      "ActionSendSmsToThingActive": false,
      "ActionSuspendActive": false,
      "ActionWebhookActive": false,
      "AlertActive": true,
      "AlertDescription": "Last usage test",
      "AlertId": "AlertId_1944f02cv-6bb5-5008-a12e-b11e0e2c181d",
      "AlertName": "Last usage alert",
      "CustomerId": "cid_ecs1d3a5-f5e62a1-fe8af468wf",
      "DateCreated": 1611912330167,
      "DateModified": 1611912330169,
      "MetricType": "Last_Usage",
      "MetricValue": 1,
      "Operation": ">=",
      "OverrideOrMultiple": "Override",
      "Severity": "Info",
      "ThingTags": [],
      "ThingsGroup": [
        "ThingsGroupId_b7786b88-e651-4997-8bh6-dfd4hh32b417",
        "ThingsGroupId_ff6421c0-bff0-4997-93abc768ee6ca9b017a"
      ],
      "Type": "AlertId"
    },
    "CellId": 12345,
    "CustomerId": "cid_ecs1d3a5-f5e62a1-fe8af468wf",
    "DateCreated": 1612095568940,
    "DateModified": 1612095568942,
    "FiredAlertDescription": "Last usage test",
    "Lac": 54321,
    "LastLocationUpdateTime": "2020-10-23 07:21:39",
    "Latitude": 12.34567,
    "Longitude": 23.45678,
    "Owner": "Demo Administrator",
    "Status": "Active",
    "TelephonyProfileId": "TelephonyProfile_ad766b40-9667-4ff1-9a79-0169467834d9",
    "TelephonyProfileName": "Default telephony profile",
    "Thing": {
      "ActivationChargeFlag": false,
      "ActiveMobileSubscriber": "123456789101112",
      "AddressSignal": "370611111111",
      "BatchId": "tutorial SIM",
      "Block": {
        "Data": false
      },
  
  ...

Returns all alarms for the account

GEThttps://console.monogoto.io/alarms/

Response

200401404

A list of all alarms

Body

application/json

alarmIdstring

Alarm Identifier

alarmDescriptionstring

Alarm Description

Alert*object

Alert configuration at the moment the alert was opened

Thing*object

Thing data at the moment the alert was opened

ThingsGroupNamestring

Things Group name the Alert was opened on

NetworkId*string

Network identifier the Alert was opened on

NetworkNamestring

Network name the Alert was opened on

TelephonyProfileIdstring

Telephony Profile identifier the Alert was opened on

TelephonyProfileNamestring

Telephony Profile name the Alert was opened on

CloseTimestring (date-time)

The alert close date and time

Ownerstring

The user handling the alert

Statusenum

Alarm status. Supported values are:

ActiveClosed

Request

JavaScriptCurlPython

const response = await fetch('https://console.monogoto.io/alarms/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401404

[
  {
    "alarmId": "text",
    "alarmDescription": "text",
    "ThingsGroupName": "text",
    "NetworkId": "text",
    "NetworkName": "text",
    "TelephonyProfileId": "text",
    "TelephonyProfileName": "text",
    "CloseTime": "2024-12-21T16:17:19.817Z",
    "Owner": "text",
    "Status": "Active"
  }
]