Skip to content

Get Alert Metadata

Return a list (or a subset) of Alert Metatada that the user has access to. Your datetime filters will be clamped to a maximum range of seven days following the processes laid out in DateTime Handling.

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

Request Body

{
  "routeFilter": {
    "alertIds": [3609],
    "alertMetadataIds": [6],
    "alertCodes": ["NS"],
    "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": [1]
  }
}

Filters Honored

  • RequestFilter
    • organizationIds
  • AlertFilter
    • alertIds
    • alertMetadataIds
    • alertCodes
    • raisedAtStart
    • raisedAtEnd
    • clearedAtStart
    • clearedAtEnd

Returns

On Success

The requested set of alert metadatas.

Response Body

[
  {
    "id": 7,
    "alertId": 1,
    "key": "foo",
    "value": "bar"
  }
]