Nirvana Labs API | Usage › List Usage Records

API Reference

Usage

usage

Methods

Get Usage Record ->

Usage

get/v1/usage/{resource_id}

Get the usage record for a single resource (metadata plus dimension history) for the current organization.

List Usage Records -> Cursor<

Usage

get/v1/usage

List per-resource usage records for the current organization. Each item is one resource with its nested dimension history (active and closed segments).

query Parameters

cursor: string

Optional

Pagination cursor returned by a previous request

limit: number

Optional

(maximum: 100, minimum: 10, default: 10)

Maximum number of items to return

Response fields

UsageList

Request example

curl https://api.nirvanalabs.io/v1/usage \
    -H "Authorization: Bearer $NIRVANA_LABS_API_KEY"

200Example

{
  "items": [
    {
      "dimensions": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "dimension": "compute_n1_standard_8",
          "ended_at": "2026-02-01T00:00:00Z",
          "quantity": 1,
          "started_at": "2026-01-01T00:00:00Z",
          "children": [
            {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "dimension": "compute_vcpu",
              "ended_at": "2026-02-01T00:00:00Z",
              "quantity": 2,
              "started_at": "2026-01-01T00:00:00Z"
            }
          ]
        }
      ],
      "ended_at": "2026-02-01T00:00:00Z",
      "project_id": "123e4567-e89b-12d3-a456-426614174000",
      "region": "us-sva-2",
      "resource_id": "123e4567-e89b-12d3-a456-426614174000",
      "resource_type": "vm",
      "started_at": "2026-01-01T00:00:00Z"
    }
  ],
  "pagination": {
    "next_cursor": "RhwniMT4B74siYZcPF8TnCdGI1l9rpPvg",
    "previous_cursor": "ARhwnmi1hA7wEbHbMjdYQlOB_ZusP4fYvw",
    "total_count": 125
  }
}

Domain types

Usage = { dimensions, ended_at, project_id, 4 more... }

Usage record for a single metered resource.

UsageDimension = { id, dimension, ended_at, 3 more... }

Top-level dimension entry; bundle heads expand via children.

UsageDimensionLeaf = { id, dimension, ended_at, 2 more... }

One ledger segment for a (resource, dimension) pair.

UsageList = { items, pagination }

UsageResourceType = "vm" | "volume" | "vpc" | 4 more...

Kind of metered resource a ledger row belongs to.