---
title: "Get mutually exclusive ROI occupancy"
method: GET
path: "/metrics/occupancy/roi/mutually-exclusive"
tags: ["metrics"]
---

# Get mutually exclusive ROI occupancy

`GET /metrics/occupancy/roi/mutually-exclusive`

## Request

- Base URL: `https://ai.nvidia.com/api/v3.3/analytics`
- URL: `https://ai.nvidia.com/api/v3.3/analytics/metrics/occupancy/roi/mutually-exclusive`
- Auth: none required
- TypeScript: <https://skmtc.dev/nvidia/apis/vss-video-analytics-apis/docs/metrics/occupancy/roi/mutually-exclusive/get.ts> (a function with typed inputs; its response is checked against the schema)

Calculate occupancy for a place from mutually exclusive ROIs at a specified time, with optional object details and timing controls.

## Query parameters

- `place` string, required
- `timestamp` string
- `objectType` string
- `objectDetails` boolean
- `timestampDelayInSec` integer
- `timeWindowInMs` integer

## Response `200`

Successful Operation.

- OccupancyBasedOnMutuallyExclusiveRois
  - `place` string, required
  - `timestamp` string, required
  - `occupancy` integer, required
  - `objectType` string, required
  - `objectDetails` object[]
    - `sensorId` string, required
    - `roiId` string, required
    - `objects` object[], required
      - `id` string, required
      - `coordinates` object, required
        - `x` number, double, required
        - `y` number, double, required
        - `z` number, double

## 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.dev/nvidia/apis/vss-video-analytics-apis.md) - [All operations](https://skmtc.dev/nvidia/apis/vss-video-analytics-apis/llms.txt) - [OpenAPI document](https://skmtc.dev/nvidia/apis/vss-video-analytics-apis/revisions/56201ed57789?raw)
