Get Alerts

Return a list (or a subset) of Alerts the user has access to. The maximum searchable range for both raised and cleared at is seven days.

Verb	POST
Endpoint	{base-url}/alerts
Max Page Size	50

Request Body

{
  "routeFilter": {
    "alertIds": [],
    "alertCodes": [],
    "isUserClearable": false,
    "raisedAtStart": "2010-11-12T13:14:15Z",
    "raisedAtEnd": "2010-11-12T13:14:15Z",
    "clearedAtStart": "2010-11-12T13:14:15Z",
    "clearedAtEnd": "2010-11-12T13:14:15Z"
  },
  "requestFilter": {
    "organizationIds": [],
    "accountIds": [],
    "siteIds": [],
    "machineIdentifiers": [],
    "includeDeleted": false
  }
}

Filters Honored

• RequestFilter
  • organizationIds
  • accountIds
  • siteIds
  • machineIdentifiers
• AlertFilter
  • alertIds
  • alertCodes
  • isUserClearable
  • raisedAtStart
  • raisedAtEnd
  • clearedAtStart
  • clearedAtEnd

Returns

On Success

The requested set of alerts.

Response Body

[
  {
    "id": 36578,
    "accountId": 161,
    "siteId": 477,
    "machineLocation": "Lunchroom - Soda",
    "machineProse": null,
    "machineId": 1402,
    "code": "NS",
    "message": "No Sales have been reported by this machine for at least 3 day(s).",
    "isCleared": false,
    "clearedAt": null,
    "raisedAt": "2021-03-29T15:56:41.677",
    "alertMetadata": []  // will always be empty
  }
]