Sign in

v1

latestOpenAPI 3.0.32026-07-24214879985.1 KB
Cameras

Returns metrics data.

get/cameras/{cameraId}/metrics

Path parameters

cameraIdstring required

Query parameters

timestamp__ltestring date-time
Example:2021-04-22T00:00:00.000+00:00

Maximum timestamp to list auditlogs.

timestamp__gtestring date-time
Example:2021-04-22T00:00:00.000+00:00

Minimum timestamp to list auditlogs.

target__instring[] required

Comma separated list of metric types. The following targets are available:

  • kilobytesOnDisk - shows how much storage capacity is used on bridge.
  • bytesPurged - shows how much data was purged. Data is marked as purged if it is removed before Minimum On Premise Retention is met.
  • bytesStored - shows how much data was stored.
  • bytesFreed - shows how much data was freed, includes purges.
  • bandwidthBackground - extra data that contains data from the past which bridge is sending to try to meet cloud retention goals and the data that are requested from cloud e.g when user is viewing a video.
  • bandwidthRealtime - the minimum amount of data, required to keep the camera operational.
[
  "kilobytesOnDisk"
]
period'day' | 'hour' | 'minute'

Defaults to hour. It performs linear interpolation to get to the target period.

Response

OK

targetstring required

Example response

[
  {
    "target": "kilobytesOnDisk",
    "dataPoints": [
      [
        1450754160000,
        3823886336
      ],
      [
        1450754220000,
        3823886336
      ]
    ]
  }
]