Sign in

v1

latestOpenAPI 3.0.32026-07-24214879985.1 KB
Video Analytics Events

Map a natural language query to a set of object filters to use in the deep search endpoints. The deep search can identify a variety of objects, including people, vehicles, and some common handheld objects such as backpacks and suitcases. The deep search can also identify the attributes of these objects, such as the color of a person's clothing or the make of a vehicle.

post/videoAnalyticEvents:parse

Query parameters

language'de-DE' | 'en-US' | 'es-ES' | 'fr-FR' | 'ja-JP' | 'nl-NL' | 'pl-PL' | 'pt-BR' | 'pt-PT' | 'sv-SE' | 'tr-TR'

IETF language tag used as main identifier of the language in the Eagle Eye Networks API. The format can be just the two character "primary language subtag" or a combination of the two character "primary language subtag" and 2 character "region subtag". Use /api/v3.0/languages API to retrieve supported language codes.

Example:pt-BR

Allows clients to request translated versions of human readable fields such as the name and description fields. If no translation is available, the values will be returned in English. If both the Accept-Language and language= query parameter are used, the query parameter value is used and the header is ignored.

Headers

Accept-Language'de-DE' | 'en-US' | 'es-ES' | 'fr-FR' | 'ja-JP' | 'nl-NL' | 'pl-PL' | 'pt-BR' | 'pt-PT' | 'sv-SE' | 'tr-TR'

IETF language tag used as main identifier of the language in the Eagle Eye Networks API. The format can be just the two character "primary language subtag" or a combination of the two character "primary language subtag" and 2 character "region subtag". Use /api/v3.0/languages API to retrieve supported language codes.

Example:pt-BR

Allows clients to request translated versions of human readable fields such as the name and description fields. If no translation is available, the values will be returned in English. If both the Accept-Language and language= query parameter are used, the query parameter value is used and the header is ignored.

Request body

querystring required

A natural language query for searching events based on their metadata.

Response

Structured information based on the user-specified query data

OR

Example response

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