v1
latestOpenAPI 3.0.32026-07-24214879985.1 KBReturns all events that were recorded within a specified time range. Filtering can be applied to retrieve events of a specified type or attributed to specific actors such as a device, user, or set of users. Either the actor or actor__in parameter must be provided to specify the actors for which events should be returned. By default, the API returns only general event information. To include additional data specific to the requested event type, use the include parameter. The possible values for the include parameter are returned in the dataSchemas field of the event object.
Data Filtering
Data filters allow filtering events based on fields within specific event data schemas. These filters follow the naming pattern data.{schemaName}.{fieldName} and apply to all event types. Events that do not contain the specified schema will be excluded from results. For example, when searching for both motion and device status events with a connectionStatus filter, motion events will not be returned (since they don't have connectionStatus), and only device status events that match the connectionStatus criteria will be returned.
Query parameters
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.
Allows clients to request optional information such us URLs necessary to configure third party IDPs.
Filter to get only records that have a startTimestamp value that is less than or equal to the given value. If endTimestamp__lte is not provided, this parameter is required.
Filter to get only records that have a startTimestamp value that is more than or equal to the given value.
Filter to get only records that have an endTimestamp value that is less than or equal to the given value. If startTimestamp__lte is not provided, this parameter is required.
Filter to get only records that have an endTimestamp value that is more than or equal to the given value.
Filter to get only events that have an actorType and actorId value that equals the given value. The actor type has to be prefixed along with actor id like actorType:actorId. For example, to filter for events for a camera with id 100d4c41, the actor that has to be used is camera:100d4c41.
Note: If both actor and actor__in are provided, the values are combined. Either actor or actor__in must be provided.
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" ]
Filter events based on the type of event. If this parameter is not specified, the API will return only een.lprPlateReadEvent.v1 events by default.
[ "een.lprPlateReadEvent.v1", "een.fleetCodeRecognitionEvent.v1" ]
Comma separated list of of fields that should be sorted. By default, the users response is sorted by first name.
- sort= - not providing any value will result in error 400
- sort=+firstName,+firstName - same values will result in error 400
- sort=-firstName,+firstName - mutually exclusive values will return error 400
- There is no limit on the number of sort fields. All available sort fields can be combined freely, as the backend supports sorting by all of them.
- 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
Filter events to only include those that have the een.deviceCloudStatusUpdate.v1 data schema and where the newStatus.connectionStatus field matches one of the specified values. Events without this data schema will be excluded.
Filter events to only include those that have the een.humanValidationDetails.v1 data schema and where the isValid field matches the specified boolean value. Events without this data schema will be excluded.
Filter events to only include those where the een.humanValidationDetails.v1 data schema is either missing OR the isValid field does not match the specified boolean value. Events without this data schema will be included. An event is considered valid until it is marked invalid by a human review system, if human review is enabled for that event type.
Filter events to only include those that have the een.deviceIO.v1 data schema and where the portId field matches one of the specified values. Events without this data schema will be excluded.
Response
OK
Example response
{
"results": [
{
"dataSchemas": [
"een.objectDetection.v1",
"een.objectClassification.v1",
"een.lprDetection.v1",
"een.personAttributes.v1",
"een.vehicleAttributes.v1",
"een.fullFrameImageUrl.v1",
"een.croppedFrameImageUrl.v1",
"een.objectRegionMapping.v1",
"een.eevaAttributes.v1",
"een.customLabels.v1"
],
"data": [
{
"id": "een.lpr",
"vendor": "Eagle Eye Networks",
"application": "Cloud License Plate Recognition",
"hardwareModel": "EN-CDUD-005a",
"version": "20230318.082522.039235885"
}
]
}
]
}