/cameras/{cameraId}/metrics

get

https://{BaseUrl}/api/v3.0/cameras/{cameraId}/metrics

Returns metrics data.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

cameraId

string

required

Query Params

timestamp__lte

date-time

Maximum timestamp to list metrics. Defaults to now.

timestamp__gte

date-time

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

target__in

array of strings

required

length ≥ 1

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.

target__in*

period

string

enum

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

Allowed:

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK