LIST Failed Alerts

GET 
/workspaces/:workspaceId/alerting/alerts/failed

Returns list of failed alerts. The format is a JSON array

Request

Path Parameters

workspaceId uuidrequired

Query Parameters

deviceId string
streamName string
streamGroupName string
ruleName string
after date-time

Filter alerts that were raised after the specified date and time.

before date-time

Filter alerts that were raised before the specified date and time.

Responses

200

List of failed alerts

application/json

Schema

Schema

alertId stringrequired

Alert GUID.

deviceId stringrequired
streamName stringrequired
streamGroupName stringrequired
ruleName stringrequired
firedTime date-time

Date and time when the alert was raised.

lastMessageTime date-time

Date and time when the last message was sent.

targets string[]required
failedTargets string[]required

Example (from schema)

{
  "alertId": "string",
  "deviceId": "string",
  "streamName": "string",
  "streamGroupName": "string",
  "ruleName": "string",
  "firedTime": "2024-12-17T17:37:35.222Z",
  "lastMessageTime": "2024-12-17T17:37:35.222Z",
  "targets": [
    "string"
  ],
  "failedTargets": [
    "string"
  ]
}

example-1

{
  "alertId": "<GUID>",
  "deviceId": "my-device",
  "streamName": "my-stream",
  "streamGroupName": "my-stream-group",
  "siteId": "my-site",
  "ruleName": "my-rule",
  "firedTime": "2020-01-01T12:00:00+00:00",
  "lastMessageTime": "2020-01-01T12:00:00+00:00",
  "targets": [
    "slack-target"
  ],
  "failedTargets": [
    "service-bus-target"
  ]
}

Loading...