EAeagleeyenetworks
Cameras

GET /cameras/{cameraId}/metrics

Returns metrics data.

Request

  • Base URL
    https://api.cxxx.eagleeyenetworks.com/api/v3.0
  • URL
    https://api.cxxx.eagleeyenetworks.com/api/v3.0/cameras/{cameraId}/metrics
  • Auth
    HTTP bearer

Path parameters

cameraIdstring required

Query parameters

timestamp__ltestring date-time
Example:2023-04-04T11:48:52.000Z

Maximum timestamp to list metrics. Defaults to now.

timestamp__gtestring date-time
Example:2023-04-04T09:38:37.372Z

Minimum timestamp to list metrics. Defaults to 7 days ago.

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
      ]
    ]
  }
]

Changes

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