GET /alerts
Search and sort alerts by creatorId, alertType, actorId, actorType, actorAccountId, ruleId, eventId, locationId, and priority. Optional information can be requested with include.
Request
- Base URLhttps://api.cxxx.eagleeyenetworks.com/api/v3.0
- URLhttps://api.cxxx.eagleeyenetworks.com/api/v3.0/alerts
- AuthHTTP bearer
Query parameters
Source data set is api/v3.0/languages
Language query overrides Accept-Language header
Filter by creatorId
Filter by timestamp__lte
Filter by timestamp__gte
Filter by alertType (supports multiple values)
Filter by actorId (supports multiple values)
Filter by actorType (supports multiple values)
Filter by actorAccountId
Filter by ruleId
Filter by one or more rule IDs (supports multiple values)
Filter by eventId
Filter by one or more location IDs.
Filter by eventType (supports multiple values)
Filter by priority__gte
Filter by priority__lte
If set to true, the API will include alerts that are invalidated by Human reviewer.
Filter by one or more alert action IDs (supports multiple values)
Filter by one or more alert action statuses (supports multiple values)
Specify additional data to include in the response (supports multiple values like data and actions).
Sort by timestamp
Token string value that references a page for pagination. This value is received when retrieving the first page in the nextPageToken and prevPageToken fields. When a pageToken is provided, the backend remembers search parameters from the original request, so search parameters that affect the result set or order are optional and will be ignored if provided. Representation parameters like include should still be applied.
The number of entries to return per page. The maximum range of valid page sizes is documented with minimum and maximum values, but the range might be further limited dynamically based on the requested information, account, and system status. Values outside of the (dynamic) allowed range will not result in an error, but will be clamped to the nearest limit. Thus, logic to detect the last page should not be based on comparing the requested size with the received size, but on the existence of a nextPageToken value.
Headers
Source data set is api/v3.0/languages
Response
Alert results
Example response
{
"results": [
{
"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."
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.