Video Analytics Events

POST /videoAnalyticEvents:deepSearchGroupByResource

Fetches matching video analytic event frequencies grouped as requested. The response is a list of groups, each with a count of matching events, and optionally a sample event.

Request

Base URL
https://api.cxxx.eagleeyenetworks.com/api/v3.0
URL
https://api.cxxx.eagleeyenetworks.com/api/v3.0/videoAnalyticEvents:deepSearchGroupByResource
Auth
HTTP bearer

Query parameters

timestamp__gtestring date-time required

Data format for the timestamp

Example:2021-04-22T00:00:00.000+00:00

Minimum range of timestamp to fetch events after this time. Default would be 2 hours from current time.

timestamp__ltestring date-time required

Data format for the timestamp

Example:2021-04-22T00:00:00.000+00:00

Maximum range of timestamp to fetch events before this time. Default would be the current time.

actor__inActorGenericId[]

Filter to get only events where the actorType and actorId value equals any one of the supplied value in the list. The actorType must be prefixed to the actorId using a colon (:) separator. For example:

To filter for a camera with ID cameraId_1, use camera:cameraId_1.
To filter for a location with ID locationId_1, use location:locationId_1.
To filter for a bridge with ID bridgeId_1, use bridge:bridgeId_1.

Currently, the following actorType values are supported:

camera: Matches the specific camera ID.
location: Matches all camera IDs associated with the specified location ID(s).
bridge: Matches all camera IDs associated with the specified bridge ID(s).

If multiple actor types are provided (e.g., camera, location, and bridge), the filter will include camera IDs associated with any of the given values.

[
  "camera:100d4c41"
]

layoutId__instring[]

Filter to get only events associated with camera Ids mapped to the specified layout Ids. Accepts a comma-separated list of layout Ids (e.g., layoutId_1,layoutId_2). All matching camera IDs for the provided layout IDs will be included in the result.

[
  "Id_1"
]

tags__anystring[]

Filter to get only events associated with camera Ids mapped to the specified tag Ids. Accepts a comma-separated list of tag Ids (e.g., tagId_1,tagId_2). All matching camera IDs for the provided tag IDs will be included in the result. Here the suffix __any is used to indicate that the filter is an OR operation, i.e., events associated with any of the provided tag IDs will be included in the result.

[
  "Id_1"
]

roiName__inROIGenericName[]

Matches with all events that have at least one motion-event related region with a name containing one or more of the values in this list. Matching is done exactly but is not case-sensitive.

[
  "Parking 1"
]

creatorId__inEventCreatorId[]

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

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

[
  "een.videoAnalytics.v1"
]

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

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.

includestring[]

List of properties that should be included in the response, if available. The data field can be used as prefix to request data if it is available. Eg. if the client wants to have object detection details and supports the een.objectDetection.v1 schemas, it can add data.een.objectDetection.v1 to the list of requested includes. This parameter does not operate as a filter, events without the requested properties are still returned.

Example:+timestamp

Sort order for the grouped results.

Value	Applicable groupBy
+timestamp / -timestamp	camera, urn:entity:person
+eventCount / -eventCount	camera, urn:entity:person
+alphabetical / -alphabetical	camera only (entities have no display name)
+relevance	camera only

groupBy'camera' | 'urn:entity:person'

Example:camera

The dimension to group events by.

camera: group by camera. Returns one result per camera with a detection count and sample events.
urn:entity:person: group by person entity. Returns one result per entity with a detection count and sample events. Use with filter.objectSimilarity.v1 (objectId as urn:entity:{entityId}) or filter.objectAtPoint.v1 to scope results to a specific entity, or without an objectSimilarity filter to list all person entities active in the queried time/camera range.

Request body

Example request

{
  "objects__all": [
    [
      {
        "upperBodyClothingColor": "white",
        "lowerBodyClothingColor": "white",
        "gender": "female"
      }
    ]
  ]
}

Response

List of events matching search criteria

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": [
    {
      "group": {
        "id": "ab13433c",
        "name": "Houston"
      },
      "count": 10,
      "lastSample": {
        "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": [
          {
            "objectId": "camera-46743c2:d3275d08-16df-4176-b9c6-688046c858a2",
            "timestamp": "2021-04-22T00:00:00.000+00:00"
          }
        ],
        "matchObjectIds": [
          "camera-46743c2:d3275d08-16df-4176-b9c6-688046c858a2"
        ]
      },
      "firstSample": {
        "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": [
          {
            "objectId": "camera-46743c2:d3275d08-16df-4176-b9c6-688046c858a2",
            "timestamp": "2021-04-22T00:00:00.000+00:00"
          }
        ],
        "matchObjectIds": [
          "camera-46743c2:d3275d08-16df-4176-b9c6-688046c858a2"
        ]
      },
      "randomSample": {
        "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": [
          {
            "objectId": "camera-46743c2:d3275d08-16df-4176-b9c6-688046c858a2",
            "timestamp": "2021-04-22T00:00:00.000+00:00"
          }
        ],
        "matchObjectIds": [
          "camera-46743c2:d3275d08-16df-4176-b9c6-688046c858a2"
        ]
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.