EAeagleeyenetworks
Video Analytics Events

POST /videoAnalyticEvents:listFieldValues

Fetches available deep search query parameters based on events matching the input filters and other query parameter inputs. Query parameters can be requested using the parameter param. It has to be noted that the values in the filter will be a subset for those fields which are mentioned in the parameter param. Eg. If the filter specifies a set of actors (such as cameras), and parameter=actor is given, the search for matching is done with the given actor filters and therefore the response will always be a subset of the given list of actors.

Request

  • Base URL
    https://api.cxxx.eagleeyenetworks.com/api/v3.0
  • URL
    https://api.cxxx.eagleeyenetworks.com/api/v3.0/videoAnalyticEvents:listFieldValues
  • 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"
]
parameter'actor' | 'region' | 'eventType' | 'creatorId' required

Provide the parameter to be returned in the response body with the list of available values for the selected parameter.

Request body

OR

Example request

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

Response

List of field values 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": [
    {
      "id": "camera:100d4c41"
    }
  ]
}

Changes

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