v1

latestOpenAPI 3.0.32026-07-24214879985.1 KB
Alerts

Get an alert

get/alerts/{id}

Path parameters

idstring required

Account ID. Use self as the Account ID to reference the account of the current session

Query parameters

includestring[]

Response

Alert result

idstring uuid
timestampstring date-time
createTimestampstring date-time
creatorIdstring
alertTypestring
alertNamestring
categorystring
serviceRuleIdstring

The UUID of the service rule id for creation.

eventTypestring
actorIdstring
actorTypestring
actorAccountIdstring
actorNamestring
ruleIdstring
eventIdstring
locationIdstring
locationNamestring nullable
priorityinteger
dataSchemasstring[]
dataobject
actionsobject
descriptionstring

Example response

{
  "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "timestamp": "2021-04-22T00:00:00.000+00:00",
  "createTimestamp": "2021-04-22T00:00:00.000+00:00",
  "creatorId": "een.auditLog",
  "alertType": "userLogin",
  "alertName": "Motion Detection Alert",
  "category": "motion",
  "serviceRuleId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "eventType": "een.vehicleDetectionEvent.v1",
  "actorId": "d22d1939-2e14-434b-8185-d324be6cf363",
  "actorType": "user",
  "actorAccountId": "00011557",
  "actorName": "John Doe",
  "locationId": "6a4dec07-d507-43d3-9977-c537fb48d341",
  "locationName": "Office",
  "description": "User \"John Doe (john.doe@example.com)\" logged in."
}