v1
latestOpenAPI 3.0.3Apache 2.02026-07-175678720.5 KBmetrics
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
timestampstring date-time required
placestring required
objectTypestring
Example:Person
Response
Successful Operation.
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"
}
}
}
]
}