Skip to content

List immutable usage and adjustment events

GET /admin/v1/workspaces/{workspaceId}/usage-events — List immutable usage and adjustment events

Updated View as Markdown
Audience: application-backendPlane: adminAuth: management-keyStatus: beta

Endpoint

GET /admin/v1/workspaces/{workspaceId}/usage-events

Operation ID: listUsageEvents

Authentication

Send a Nexus Management Key as Authorization: Bearer <management-key>. This credential is control-plane only.

Idempotency

This operation does not declare an Idempotency-Key requirement in the accepted OpenAPI contract.

Request

Parameters

Name Location Required Schema Description
workspaceId path Yes string
cursor query No string
limit query No number

Body

This operation has no request body.

Responses

Status Description Content type Schema
200 application/json array<UsageEventDto>

Only responses explicitly declared by the accepted Admin OpenAPI contract are shown. The current contract does not declare operation-specific error bodies; the SDK preserves any non-success status and body in AdminApiError.

200 application/json schema

Type: array<UsageEventDto>

Field Required Type Description
[].id Yes string
[].workspaceId Yes string
[].workspaceAccessId Yes string
[].quotaPeriodId Yes string
[].reservationId No string
[].invocationId Yes string
[].eventType Yes string
[].inputTokens Yes string
[].cachedInputTokens Yes string
[].outputTokens Yes string
[].quotaUnitsDelta Yes string
[].occurredAt Yes string / date-time
[].reason No string
[].adjustsEventId No string

Examples

TypeScript Management SDK

NexusAdminClient.listUsageEvents uses AdminOperationInput<"listUsageEvents"> and returns Promise<AdminOperationOutput<"listUsageEvents">>.

import { NexusAdminClient } from '@nexus/sdk-typescript';

const nexus = new NexusAdminClient({
  baseUrl: 'https://nexus.microvoid.io',
  managementKey: process.env.NEXUS_MANAGEMENT_KEY,
});

const result = await nexus.listUsageEvents({
  path: {
    workspaceId: '533c4e1e-2823-4349-86b9-d6f1a869a2ca',
  },
});

Fetch

const response = await fetch(
  'https://nexus.microvoid.io/admin/v1/workspaces/533c4e1e-2823-4349-86b9-d6f1a869a2ca/usage-events',
  {
    method: 'GET',
    headers: {
      Authorization: `Bearer ${process.env.NEXUS_MANAGEMENT_KEY}`,
    },
  },
);

if (!response.ok) throw new Error(`Nexus request failed: ${response.status}`);

curl

curl --request GET \
  "https://nexus.microvoid.io/admin/v1/workspaces/533c4e1e-2823-4349-86b9-d6f1a869a2ca/usage-events" \
  --header "Authorization: Bearer ${NEXUS_MANAGEMENT_KEY}"
Navigation

Type to search…

↑↓ navigate↵ selectEsc close