---
title: "Get Alerts"
method: GET
path: "/alerts"
tags: ["alerts"]
---

# Get Alerts

`GET /alerts`

## Query parameters

- `sensorId` string
- `place` string
- `objectId` string
- `fromTimestamp` string, date-time
- `toTimestamp` string, date-time
- `objectType` string
- `queryString` string
- `maxResultSize` integer
- `vlmVerified` boolean
- `vlmVerdict` 'all' | 'confirmed' | 'rejected' | 'verification-failed' | 'not-confirmed'

## Response `200`

Successful Operation.

- Alerts
  - `alerts` Behavior[], required
    - `timestamp` string, date-time, required
    - `Id` string, required
    - `id` string, required
    - `timeInterval` number, float, required
    - `end` string, date-time, required
    - `locations` Locations, required
      - `type` 'linestring', required — Type of Geoshape
      - `coordinates` array[], required
        - number[]
    - `smoothLocations` Locations
      - `type` 'linestring', required — Type of Geoshape
      - `coordinates` array[], required
        - number[]
    - `length` integer, required
    - `speedOverTime` number[], required
    - `sensor` Sensor, required
      - `id` string, required
      - `description` string, required
      - `type` string, required
      - `info` object
    - `place` Place, required
      - `name` string, required
      - `info` object
    - `event` Event, nullable
      - `type` string, required — Allowed values for tripwire events: 'IN', 'OUT'. Allowed values for roi events: 'ENTRY', 'EXIT'.
      - `id` string, required
      - `info` object
    - `object` Object, required
      - `type` string, required
      - `location` object, required
        - `lon` number, double, required
        - `lat` number, double, required
        - `alt` number, double, required
      - `bbox` Bbox, required
        - `topY` number, double, required
        - `rightX` number, double, required
        - `bottomY` number, double, required
        - `leftX` number, double, required
        - `embeddings` object[], required
          - `vector` number[], required
        - `confidence` number, float, required
        - `info` object
      - `id` string, required
      - `speed` number, double, required
      - `coordinate` object, required
        - `x` number, double, required
        - `y` number, double, required
        - `z` number, double, required
      - `info` object
    - `edges` string[]
    - `analyticsModule` AnalyticsModule
      - `id` string
      - `description` string
      - `version` string
      - `source` string
      - `info` object
    - `direction` 'N' | 'NNE' | 'NE' | 'ENE' | 'E' | 'ESE' | 'SE' | 'SSE' | 'S' | 'SSW' | 'SW' | 'WSW' | 'W' | 'WNW' | 'NW' | 'NNW' | 'Right' | 'Left' | 'Up' | 'Down', required
    - `speed` number, double, required
    - `distance` number, double, required
    - `bearing` number, double, required
    - `videoPath` string, required

## Other responses

- `400` — Bad Request. This response will be sent if any of the required params are not present or if extra params are passed. It will also be sent if parameter dependencies (mentioned in parameter descriptions) are not satisfied.
- `404` — Resource Not Found
- `422` — Unprocessable Entity
- `500` — Internal Server Error

---

[API](https://skmtc.net/nvidia/apis/vss-video-analytics-apis.md) · [All operations](https://skmtc.net/nvidia/apis/vss-video-analytics-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nvidia/vss-video-analytics-apis/versions/0ff2b2f41244/schema)