---
title: "Get Roi Occupancy of a sensor."
method: GET
path: "/metrics/occupancy/roi"
tags: ["metrics"]
---

# Get Roi Occupancy of a sensor.

`GET /metrics/occupancy/roi`

## Query parameters

- `fromTimestamp` string, date-time, required
- `toTimestamp` string, date-time, required
- `sensorId` string, required
- `roiId` string
- `objectType` string

## Response `200`

Successful Operation.

- RoiCounts
  - `roiOccupancy` object[], required
    - `roiId` string, required
    - `objects` object[], required
      - `type` string, required
      - `averageCount` number, double, required
      - `uniqueObjectCount` integer, 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.
- `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)