---
title: "POST /videoAnalyticEvents:listFieldValues"
method: POST
path: "/videoAnalyticEvents:listFieldValues"
tags: ["Video Analytics Events"]
---

# POST /videoAnalyticEvents:listFieldValues

`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.

## Query parameters

- `timestamp__gte` string, date-time
- `timestamp__lte` string, date-time
- `actor` string[]
- `layoutId__in` string[]
- `tags__any` string[]
- `roiName__in` ROIGenericName[]
- `creatorId__in` EventCreatorId[]
- `eventType__in` EventType[]
- `parameter` 'actor' | 'region' | 'eventType' | 'creatorId', required

## Request body

- union — Structure containing the search criteria. Can be either: - Filter-based search using objects__all with detailed filter types - Natural language search using a query string
  - object
    - `objects__all` array[], required — List of all objects that need to be found for an event to match, each defined by a set of filters. The VMS can identify people, vehicles, and a variety of common objects. You can generate a valid filter by using the [`POST /videoAnalyticEvents:parse`](https://developer.eagleeyenetworks.com/reference/parsevideoanalytics) endpoint.
      - union[] — Set of filters the object has to match with.
        - union
          - FilterObjectClassificationV1
            - `type` 'filter.objectClassification.v1', required — Type of the filter selected
            - `class` 'person' | 'vehicle' | 'suitcase' | 'backpack' | 'handbag' | 'weapon' | 'face' | 'animal' | 'fire', required — The `class` of the object
          - FilterPersonAttributesV1 — Attributes related to a person detected in an event image
            - `type` 'filter.personAttributes.v1', required — Type of the filter selected
            - `upperBodyClothingColor` 'black' | 'blue' | 'brown' | 'gold-beige' | 'green' | 'gray' | 'silver' | 'silver-gray' | 'orange' | 'pink' | 'purple' | 'red' | 'white' | 'yellow' — Enumerations of upperbody clothing color for person.
            - `lowerBodyClothingColor` 'black' | 'blue' | 'brown' | 'gold-beige' | 'green' | 'gray' | 'silver' | 'silver-gray' | 'orange' | 'pink' | 'purple' | 'red' | 'white' | 'yellow' — Enumerations of lowerbody clothing color for person.
            - `gender` 'male' | 'female' — Enumerations of gender for person.
            - `stationary` boolean — Information regarding whether the person is moving or not
            - `helmet` boolean — Information regarding whether the person is wearing a helmet or not
            - `vest` boolean — Information regarding whether the person is wearing a vest or not
          - FilterVehicleAttributesV1 — Attributes related to the vehicle detected in an event image
            - `type` 'filter.vehicleAttributes.v1', required — Type of the filter selected
            - `color` 'beige' | 'black' | 'blue' | 'brown' | 'burgundy' | 'gold-beige' | 'green' | 'gray' | 'silver' | 'silver-gray' | 'maroon' | 'orange' | 'pink' | 'purple' | 'red' | 'teal' | 'white' | 'yellow' — Enumerations of standard colors for vehicles.
            - `make` 'abarth' | 'acura' | 'alfa_romeo' | 'aston_martin' | 'audi' | 'bentley' | 'bmw' | 'bugatti' | 'buick' | 'byd' | 'cadillac' | 'chevrolet' | 'chrysler' | 'citroen' | 'dacia' | 'daihatsu' | 'dodge' | 'dodge_ram' | 'ferrari' | 'fiat' | 'fisker' | 'ford' | 'ford_mustang' | 'garia' | 'genesis' | 'gmc' | 'harley_davidson' | 'honda' | 'hummer' | 'hyundai' | 'infiniti' | 'isuzu' | 'jaguar' | 'jeep' | 'kia' | 'lamborghini' | 'land_rover' | 'lexus' | 'lincoln' | 'lotus' | 'lucid' | 'mahindra' | 'maruti_suzuki' | 'maserati' | 'mazda' | 'mclaren' | 'mercedes_benz' | 'mini_cooper' | 'mitsubishi' | 'mg' | 'nissan' | 'oldsmobile' | 'opel' | 'perodua' | 'peugeot' | 'plymouth' | 'polaris' | 'polestar' | 'pontiac' | 'porsche' | 'proton' | 'ram' | 'renault' | 'rivian' | 'rolls_royce' | 'rover' | 'saab' | 'saturn' | 'scion' | 'skoda' | 'smart' | 'subaru' | 'suzuki' | 'tata' | 'tesla' | 'toyota' | 'vinfast' | 'volkswagen' | 'volvo' | 'wagoneer' | 'others' — Enumerations of standard makes/brands for vehicles.
            - `bodyType` 'motorbike' | 'car' | 'bus' | 'truck' | 'sedan' | 'hatchback' | 'coupe' | 'convertible' | 'minivan' | 'wagon' | 'trike' | 'roadster' | 'crossover' | 'scooter' | 'sports_car' | 'van' | 'bicycle' | 'tukTuk' | 'suv' | 'pickupTruck' | 'forklift' | 'others' — Enumerations of standard classes for vehicles. Warning: These body types are subject to future modifications
            - `parked` boolean — Information regarding whether the vehicle is parked or not
          - union — This filter can be used for the following: - To support searching for events with unique objects and eliminate the presence of duplicate results in the response - To search for all instances of a selected unique object. Searching for multiple objects in a single query will not be supported when the `objectSimilarity` filter is present in the request. When `objectId` is provided, the search resolves results using a two-tier approach: 1. **Entity match** — the objectId is resolved to a known person entity and all detections belonging to that entity are returned. The response metadata reports `type: objectSimilarity` and `resolution: entity`. 2. **Metadata fallback** — when no entity match is found and `enableFallback` is true (default), the object's metadata attributes are used for matching. The response metadata reports `type: objectSimilarity` and `resolution: metadataFallback`.
            - object
              - …
            - object
              - …
          - FilterCustomLabelsV1
            - `type` 'filter.customLabels.v1', required — Type of the filter selected
            - `label` string, required — Label user wants to search for.
          - FilterObjectAtPointV1 — Searches for all appearances of the object nearest to a clicked point in a camera frame. The caller supplies the camera, timestamp, and normalized click coordinates; the server resolves the matching entity and returns all associated detections.
            - `type` 'filter.objectAtPoint.v1', required — Type of the filter selected
            - `actor` string, required — Actor (camera) to fetch the preview frame from, in `actorType:actorId` format.
            - `timestamp` string, date-time, required — Time of the frame to inspect (RFC 3339).
            - `referencePoint` object, required — Normalized coordinates of the point clicked within the frame.
              - …
  - object
    - `query` string, required — Natural language text query for semantic search. Searches for persons, vehicles, and scenes based on text descriptions. Maximum 7 words recommended for optimal results. Examples: "person with red jacket", "blue sedan car", "person carrying backpack"
    - `disableSpellCheck` boolean — If true, disables automatic spell correction and uses the original query text as-is. If false or omitted, the server will attempt to correct spelling mistakes.

## Response `200`

List of field values matching search criteria

- object — 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` union[], required — The result set from a collection API call.
    - union
      - object — Details of the selected group
        - `type` 'actor', required — Type of the data
        - `id` string, required — This parameter filters events based on associated camera IDs for the specified actors. The actor type is prefixed along with the actor ID in the format `actorType:actorId`. Supported actor types: - `camera` (e.g. `camera:100d4c41`) - `location` (e.g. `location:d0e4aad4-06c5-4c43-a4ac-3106738ed206`) - `bridge` (e.g. `bridge:10035b4a`)
      - object — Details of the region where object is found
        - `type` 'region', required — Type of the data
        - `id` string
        - `name` string, required
      - object — Details of the creator of the event
        - `type` 'creatorId', required — Type of the data
        - `id` string, required
      - object — Details of the type of the event
        - `type` 'eventType', required — Type of the data
        - `id` string, required

## 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.
- `404` — Referenced resource could not be found.
- `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/versions/df57313de545/schema)