NVnvidia
metrics

Get tripwire-based occupancy

Calculate occupancy for a place at a specified time from IN/OUT tripwire events and occupancy reset values. Use the occupancy reset endpoint to establish an accurate baseline.

get/metrics/occupancy/tripwire

Request

Query parameters

timestampstring date-time required
placestring required
objectTypestring
Example:Person

Response

Successful Operation.

placestring required
timestampstring date-time required

Example response

{
  "place": "building=sjc14/zone=lobby",
  "timestamp": "2022-08-25T00:00:10.000Z",
  "occupancy": [
    {
      "objectType": "Person",
      "count": 8,
      "details": {
        "events": [
          {
            "type": "IN",
            "count": 6
          }
        ],
        "occupancyReset": {
          "resetValue": 2,
          "resetTimestamp": "2022-08-25T00:00:00.000Z"
        }
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 9 revisions of this API.