---
title: "Get effective and actual tripwire counts for a sensor."
method: GET
path: "/metrics/tripwire/counts"
tags: ["metrics"]
---

# Get effective and actual tripwire counts for a sensor.

`GET /metrics/tripwire/counts`

## Query parameters

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

## Response `200`

Successful Operation.

- TripwireCounts
  - `tripwireMetrics` object[], required
    - `id` string, required
    - `events` object[], required
      - `type` string, required
      - `count` integer, required — Effective counts are used to count only the effective event generated by an object. An effective tripwire event can be defined with the following example: Suppose an object generates tripwire events in the following sequence: IN, OUT and IN again, then the effective count in this case considers only the final IN event. This is helpful to handle loitering behavior of an object.
      - `actualCount` integer, required — Actual tripwire count is the count of all the events that have occurred.
      - `objectType` string, required
  - `aggregatedMetrics` object, required
    - `events` object[], required
      - `type` string, required
      - `count` integer, required — Effective counts are used to count only the effective event generated by an object. An effective tripwire event can be defined with the following example: Suppose an object generates tripwire events in the following sequence: IN, OUT and IN again, then the effective count in this case considers only the final IN event. This is helpful to handle loitering behavior of an object.
      - `actualCount` integer, required — Actual tripwire count is the count of all the events that have occurred.
      - `objectType` 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.
- `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)
