---
title: "List NVR metrics"
method: GET
path: "/v1/nvrs/metrics"
tags: ["nvrs"]
---

# List NVR metrics

`GET /v1/nvrs/metrics`

## Request

- Base URL: `https://developer.coram.ai`
- URL: `https://developer.coram.ai/v1/nvrs/metrics`
- Auth: API key in header `X-Auth-Token`

Returns current aggregate CPU utilization for authorized NVRs in UUID order. Requires read:* scope
and at least LIVE_ONLY surveillance access. Full-access users see every
tenant-owned NVR, including devices without a location. Restricted users
see NVRs at their allowed locations or camera-group locations.
CPU uses the Grafana five-minute rate calculation across available modes,
excluding idle and I/O-wait from the numerator. Invalid, stale or unavailable
telemetry is null; required database failures fail the request. Unknown or
inaccessible NVR identifiers return an empty collection. Pagination is not
a snapshot across inventory changes. Clients must tolerate additive fields.

## Query parameters

- `page` integer
- `limit` integer
- `nvr` string

## Headers

- `X-Tenant-User` string
- `X-Tenant-Org` string

## Response `200`

Authorized NVR metrics page.

- NVRMetricsPage
  - `results` NVRMetrics[], required: NVR records returned for the requested page.
    - `nvr` string, required: Unique NVR identifier.
    - `aggregate_cpu_usage` NVRMetric, nullable, required: A numeric NVR measurement with its unit, observation time, and optional aggregation window. Null if telemetry is unavailable or invalid.
      - `value` number, required: Numeric measurement value.
      - `unit` 'percent', required: Unit of the measurement.
      - `window_seconds` integer, nullable, required: Measurement window in seconds; null for a direct sample.
      - `observed_at` string, date-time, required: Source observation time (UTC).
  - `has_more` boolean, required: True if another page of results is available.

## Other responses

- `400`: Invalid query parameters or tenant selection.
- `401`: API key is missing, invalid, revoked, or expired.
- `403`: API key lacks the required permissions or access to the requested organization.
- `404`: The user specified in X-Tenant-User was not found.
- `429`: Too many requests. Try again later.
- `500`: Failed to retrieve NVR metrics data.

## Changes

- **2026-10-15** `f3fe1746718f`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/coram/apis/coram-api/changes/v1/nvrs/metrics/get.md)

---

[API](https://skmtc.dev/coram/apis/coram-api.md) - [All operations](https://skmtc.dev/coram/apis/coram-api/llms.txt) - [OpenAPI document](https://skmtc.dev/coram/apis/coram-api/revisions/00df3cfc762f?raw)