Sign in

v1

latestOpenAPI 3.0.3Apache 2.02026-07-175678720.5 KB
metrics

Get effective and actual tripwire counts for a sensor.

get/metrics/tripwire/counts

Query parameters

fromTimestampstring date-time required
toTimestampstring date-time required
sensorIdstring required
tripwireIdstring
objectTypestring

Response

Successful Operation.

Example response

{
  "tripwireMetrics": [
    {
      "id": "tripwire-id-1",
      "events": [
        {
          "type": "IN",
          "count": 0,
          "actualCount": 18,
          "objectType": "Forklift"
        },
        {
          "type": "OUT",
          "count": 0,
          "actualCount": 18,
          "objectType": "Forklift"
        },
        {
          "type": "IN",
          "count": 18,
          "actualCount": 18,
          "objectType": "Person"
        },
        {
          "type": "OUT",
          "count": 18,
          "actualCount": 18,
          "objectType": "Person"
        }
      ]
    }
  ],
  "aggregatedMetrics": {
    "events": [
      {
        "type": "IN",
        "count": 0,
        "actualCount": 18,
        "objectType": "Forklift"
      },
      {
        "type": "OUT",
        "count": 0,
        "actualCount": 18,
        "objectType": "Forklift"
      },
      {
        "type": "IN",
        "count": 18,
        "actualCount": 18,
        "objectType": "Person"
      },
      {
        "type": "OUT",
        "count": 18,
        "actualCount": 18,
        "objectType": "Person"
      }
    ]
  }
}