---
title: "It is used to calculate occupancy based on IN/OUT tripwire events and the value of reset occupancy. It is advised to reset a place's occupancy by using '/occupancy/reset' endpoint. This helps in keeping the occupancy calculated to be accurate."
method: GET
path: "/metrics/occupancy/tripwire"
tags: ["metrics"]
---

# It is used to calculate occupancy based on IN/OUT tripwire events and the value of reset occupancy. It is advised to reset a place's occupancy by using '/occupancy/reset' endpoint. This helps in keeping the occupancy calculated to be accurate.

`GET /metrics/occupancy/tripwire`

## Query parameters

- `timestamp` string, date-time, required
- `place` string, required
- `objectType` string

## Response `200`

Successful Operation.

- TripwireOccupancy
  - `place` string, required
  - `timestamp` string, date-time, required
  - `occupancy` object[], required
    - `objectType` string, required
    - `count` integer, required
    - `details` object, required
      - `events` object[], required
        - `type` 'IN' | 'OUT', required
        - `count` integer, required
      - `occupancyReset` object, nullable, required
        - `resetValue` integer, required
        - `resetTimestamp` string, date-time, 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)