Retrieves a subset of the alerts that have been directed at a user. The user is identified by the clientKey query parameter; the span of alerts is defined by the values given by the offset and count query parameters.

The alerts are returned as objects in the userAlerts array in reverse chronological order (newest first). The composition of an alert object depends on the type of alert and the alert provider, but there are two properties that you can count on:

  • alertId uniquely identifies the alert.

  • alertType is a user-friendly depiction of the alert's type.

Although alertType can be useful information to display to the user, it's expected that you'll ignore the rest of the object and, instead, display the information that you retrieve by passing an alert's alertId as a path parameter to the "Retrieve Alert Details" operation.

To receive alerts, the user must first be enrolled in a monitored alert product as explained in the "Enroll a User in Monitored Alerts" operation.

Click Try It! to start a request and see the response here!