EAeagleeyenetworks
Bridges

GET /bridges/{bridgeId}/metrics

Returns metrics data.

Request

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

Path parameters

bridgeIdstring 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.
  • availableKilobytesOnDisk - shows how much storage capacity is not used on bridge.
  • bytesStored - shows how much data was stored.
  • 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 bridge operational.
  • bytesFreed - shows how much data was freed, includes purges.
  • bandwidth - the bandwidth as measured while sending data to the cloud.
[
  "kilobytesOnDisk",
  "availableKilobytesOnDisk"
]
period'day' | 'hour' | 'minute'

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

Response

OK

MetricQueryResponse2 required(unresolved $ref)

Changes

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