Sign in

v1

latestOpenAPI 3.0.3Apache 2.02026-07-175678720.5 KB
metrics

Get a histogram of tripwire counts. Please check the input descriptions to check its dependencies.

get/metrics/tripwire/histogram

Query parameters

sensorIdstring required
tripwireIdstring
fromTimestampstring date-time

This parameter must be used together with toTimestamp. However, it is not compatible with minutesAgo.

toTimestampstring date-time

This parameter must be used together with fromTimestamp. However, it is not compatible with minutesAgo.

minutesAgointeger

This parameter is not compatible with fromTimestamp and toTimestamp.

bucketCountinteger

This parameter provided by user is a suggestion which will be taken into account while calculating bucket size in sec (which will be a multiple of 5). There is a possibilty that the result will have less/more buckets than the one provided in the input (i.e. it can go above 1000 buckets).

objectTypestring
Example:Person

Response

Successful Operation.

bucketSizeInSecinteger required

Example response

{
  "bucketSizeInSec": 360,
  "tripwires": [
    {
      "id": "tripwire-id-1",
      "histogram": [
        {
          "start": "2022-11-20T05:00:00.000Z",
          "end": "2022-11-20T05:06:00.000Z",
          "events": [
            {
              "type": "IN",
              "count": 4,
              "actualCount": 4,
              "objectType": "Forklift"
            },
            {
              "type": "OUT",
              "count": 4,
              "actualCount": 4,
              "objectType": "Forklift"
            },
            {
              "type": "IN",
              "count": 4,
              "actualCount": 4,
              "objectType": "Person"
            },
            {
              "type": "OUT",
              "count": 4,
              "actualCount": 4,
              "objectType": "Person"
            }
          ]
        }
      ]
    }
  ]
}