NVnvidia
metrics

Get space utilization histogram

Aggregate ROI space-utilization values into time buckets, optionally filtered by ROI identifiers and time window.

get/metrics/space-utilization/histogram

Request

Query parameters

roiIdsstring[] 
[
  "hazard_zone_1"
]
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).

Response

Successful Operation.

bucketSizeInSecinteger required

Example response

{
  "rois": [
    {
      "id": "hazard_zone_1",
      "histogram": [
        {
          "start": "2024-08-25T00:00:00.000Z",
          "end": "2024-08-25T00:00:10.000Z"
        }
      ]
    }
  ]
}

Changes

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