Sign in

v1

latestOpenAPI 3.0.32026-07-24214879985.1 KB
Event Alert Rules

List the configured event alert condition rules in the account. Parameters can be used to filter the rules based on the actor, name, and enabled status. A list of the availible field values for each field can be fetched using the listFieldValues endpoint.

get/eventAlertConditionRules

Query parameters

actorstring[]

Filter to get only events where the actorType and actorId value equals any one of the supplied value in the list. For each entry of list, the actor type has to be prefixed along with actor id like actorType:actorId. For example, to filter for camera with id 100d4c41, the actorId that has to be used is camera:100d4c41. To search for events from a specific type of actor, for example users, use a wildcard as actorId: user:*.

[
  "camera:100d4c41",
  "location:abcd1234"
]
name__containsstring

Filter to get the accounts whose name contains the provided substring. The lookup is exact and case insensitive.

enabledboolean

Filter against enabled rules (when set to true) or disabled rules (when set to false)

eventFilter.eventTypes__containsstring[]

Filter to only include results that contain all the specified event types.

eventFilter.eventTypes__instring[]

Filter to only include results that contain one of the specified event types.

priority__gteinteger

Filter by priority__gte

priority__lteinteger

Filter by priority__lte

includeStateSourceboolean

When true, the response also includes rules that have stateSource set. By default such rules are excluded because their alert publication is gated by external state and therefore they are not part of the standard rule listing.

stateSource__instring[]

Filter to return only rules whose stateSource matches one of the supplied URNs. Values are matched against the full URN (e.g. urn:een:alarm:<alarmId>). When supplied, rules with a matching stateSource are returned regardless of the includeStateSource flag.

[
  "urn:een:alarm:8c505a0c-188d-46f4-b54f-ea5a2a8df762"
]
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.

Response

All the rules that met the filter criteria of this API inputs.

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.

totalSizeinteger nullable

The number of resource entries being returned from the result set. This can be omitted if the API endpoint does not have total size information.

Example response

{
  "results": [
    {
      "name": "Alert on Motion detection",
      "notes": "Generate alerts on Motion Detection at night.",
      "humanValidation": {
        "enabled": true,
        "service": "eenV1"
      },
      "eventFilter": {
        "eventTypes": [
          "een.lprPlateReadEvent.v1"
        ],
        "resourceFilter": {
          "actors": [
            {
              "id": "100b913c"
            }
          ]
        }
      },
      "createTimeStamp": "2021-04-22T00:00:00.000+00:00",
      "updateTimeStamp": "2021-04-22T00:20:00.000+00:00",
      "outputAlertTypes": [
        "een.motionDetectionAlert.v1"
      ],
      "endUserAccountId": "00012345"
    }
  ]
}