--- title: "GET /eventAlertConditionRules" method: GET path: "/eventAlertConditionRules" tags: ["Event Alert Rules"] --- # GET /eventAlertConditionRules `GET /eventAlertConditionRules` 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`](https://developer.eagleeyenetworks.com/reference/geteventalertconditionrulesfieldvalues) endpoint. ## Query parameters - `actor` string[] - `name__contains` string - `enabled` boolean - `eventFilter.eventTypes__contains` string[] - `eventFilter.eventTypes__in` string[] - `priority__gte` integer - `priority__lte` integer - `includeStateSource` boolean - `stateSource__in` string[] - `pageToken` string - `pageSize` integer ## Response `200` All the rules that met the filter criteria of this API inputs. - ApiEventRulesResult — Used to wrap results for a paginated response, containing information on how to retrieve further pages and, if available, the total number of results. - `nextPageToken` string, 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. - `prevPageToken` string, 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. - `totalSize` integer, 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. - `results` object[], required — The result set from a collection API call. - `name` string — Name for the rule - `priority` integer — Defines the priority of the alert - `notes` string — A verbose explanation of the rule - `enabled` boolean — Whether rule is enabled - `cooldownSeconds` integer — Cooldown period (in seconds). If two events for the same actor and event type have event timestamps within this duration, only the first will trigger an alert while the second event will be suppressed. A value of 0 disables the cooldown checks. - `humanValidation` object - `enabled` boolean — If set to true, the alert will be validated by a human before being applied. This is useful for rules that are not 100% reliable and need human confirmation. - `service` 'eenV1' — The service that will be used for human validation. Currently, the only supported service is Eagle Eye Human Review, which is the default. - `maxWaitTimeSeconds` integer — The maximum time (in seconds) to wait for human validation before the alert is applied. If the human validation is not completed within this time, the alert will be applied automatically. - `eventFilter` EventFilter — A list of attributes of the event used to funnel down a specific set of events for any downstream action. This filtering construct is as such independent of VSP and quite generic - `eventTypes` string[] — List of event types allowed to be processed by this rule - `schedule` WeeklyIntervalScheduleAllRequired — It signifies a week long alert schedule. This schedule is effective according to actor's (user/camera/account) timezone. It allows setting different times for different days. - `sunday` Interval[], required - `start` string, required — Starting point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for a day - `end` string, required — End point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for the day - `monday` Interval[], required - `start` string, required — Starting point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for a day - `end` string, required — End point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for the day - `tuesday` Interval[], required - `start` string, required — Starting point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for a day - `end` string, required — End point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for the day - `wednesday` Interval[], required - `start` string, required — Starting point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for a day - `end` string, required — End point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for the day - `thursday` Interval[], required - `start` string, required — Starting point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for a day - `end` string, required — End point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for the day - `friday` Interval[], required - `start` string, required — Starting point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for a day - `end` string, required — End point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for the day - `saturday` Interval[], required - `start` string, required — Starting point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for a day - `end` string, required — End point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for the day - `resourceFilter` ResourceFilter — List of actors against which filtering to happen (camera/location/account) - `actors` ActorFilter[] — List of the actors for which events are checked. - `id` string — The id of the thing that caused the event This can be camera or location ID. If not supplied for any entry in the array, it is taken to mean as the entire account. - `type` 'camera' | 'location', required — Type of actor that caused the event. - `id` string — The system generated id of this rule resource - `createTimeStamp` string, date-time — Time at which the Alert Condition Rule was created. - `updateTimeStamp` string, date-time — Time at which the Alert Condition Rule was last updated. - `outputAlertTypes` string[] — Possible Alert Types that are producible by this rule. For a given event, what alert is produced depends on the configuration parameters of the rule and the event properties. - `endUserAccountId` string, nullable — The end user account this rule targets. Available only for a rule created by a reseller targeting an end user; `null` otherwise. ## Other responses - `400` — The supplied object is invalid. Error detail will contain the validation error. - `401` — You are not authenticated. Please authenticate and try again. - `403` — You have no permission to access the specified resource. - `500` — Something went wrong in the server. Please try again. --- [API](https://skmtc.net/eagleeyenetworks/apis/devices.md) · [All operations](https://skmtc.net/eagleeyenetworks/apis/devices/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/eagleeyenetworks/devices/revisions/df57313de545/schema)