Sign in

v1

latestOpenAPI 3.0.32026-07-24214879985.1 KB
Alerts

Search and sort alerts by creatorId, alertType, actorId, actorType, actorAccountId, ruleId, eventId, locationId, and priority. Optional information can be requested with include.

get/alerts

Query parameters

languagestring

Source data set is api/v3.0/languages

Example:en-US

Language query overrides Accept-Language header

creatorIdstring

Filter by creatorId

timestamp__ltestring date-time

Filter by timestamp__lte

timestamp__gtestring date-time

Filter by timestamp__gte

alertType__instring[]

Filter by alertType (supports multiple values)

actorId__instring[]

Filter by actorId (supports multiple values)

actorType__instring[]

Filter by actorType (supports multiple values)

actorAccountIdstring

Filter by actorAccountId

ruleIdstring uuid

Filter by ruleId

ruleId__instring[]

Filter by one or more rule IDs (supports multiple values)

eventIdstring

Find visit containing this entry or exit event ID

locationId__instring[]

List of Location IDs to filter on that is comma separated.

[
  "2428fda3-389f-48ce-b062-85875dd6b2e2"
]
eventType__inEventType[]

Filter to get only events that have a type value that equals one of the given parameter values.

To get the list of event types that have been recorded for a specific actor/device, use /videoAnalyticEvents:listFieldValues.

[
  "een.tamperDetectionEvent.v1"
]
priority__gteinteger

Filter by priority__gte

priority__lteinteger

Filter by priority__lte

showInvalidAlertsboolean

If set to true, the API will include alerts that are invalidated by Human reviewer.

alertActionId__instring[]

Filter by one or more alert action IDs (supports multiple values)

alertActionStatus__instring[]

Filter by one or more alert action statuses (supports multiple values)

includestring[]
sortstring[]

Comma separated list of of fields that should be sorted.

  • sort= - not providing any value will result in error 400
  • sort=+name,+name - same values will result in error 400
  • sort=-name,+name - mutially exclusive values will return error 400
  • maxItem=3 - Only Three values will be accepted, more will return error 400
  • qRelevance is optional ordering parameter which is available if q filter is used, if q filter is not passed qRelevance as ordering parameter will return error 400
pageTokenstring

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.

pageSizeinteger

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

tagstring required

IETF language tag used as main identifier of the language in the Eagle Eye Networks API. The format can be just the two character "primary language subtag" or a combination of the two character "primary language subtag" and 2 character "region subtag".

namestring required

Name of the language in native language, with an optional region in parentheses, eg. ‘Espanol’ for Spanish.

{
  "tag": "pt-BR",
  "name": "Português (Brasil)"
}

Response

Alert results

nextPageTokenstring nullable required

Token to retrieve the next page. The value of this token is passed into the field pageToken. This value can be null if there is no next page.

prevPageTokenstring nullable required

Token to retrieve the previous page. The value of this token is passed into the field pageToken. This value can be null of there is no previous page.

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."
    }
  ]
}