Usage and spend

Usage time series (hour or day buckets) from the ledger

Defaults to the current period at day granularity; hour granularity covers at most 31 days, day at most 400. workspace_id / volume_id (mutually exclusive) narrow it to one workspace or one shared volume (meter volume_storage_gib_seconds). API keys see only their own project.

get/v1/organizations/{organization_id}/usage

Request

  • Base URL: https://api.shardflux.dev
  • URL: https://api.shardflux.dev/v1/organizations/{organization_id}/usage
  • Auth: HTTP bearer

Path parameters

organization_idstring uuid required

UUIDv7, lowercase canonical form.

Query parameters

fromstring date-time

RFC 3339 UTC timestamp with Z.

tostring date-time

RFC 3339 UTC timestamp with Z.

'hour'
OR
'day'
meter'cpu_seconds' | 'memory_gib_seconds' | 'storage_gib_seconds' | 'egress_bytes' | 'ingress_bytes' | 'volume_storage_gib_seconds' | 'gpu_seconds'
workspace_idstring uuid

UUIDv7, lowercase canonical form.

volume_idstring uuid

UUIDv7, lowercase canonical form.

project_idstring uuid

UUIDv7, lowercase canonical form.

Response

Default Response

organization_idstring uuid required

UUIDv7, lowercase canonical form.

workspace_idstring uuid nullable required

UUIDv7, lowercase canonical form.

volume_idstring uuid nullable required

UUIDv7, lowercase canonical form.

project_idstring uuid nullable required

UUIDv7, lowercase canonical form.

fromstring date-time required

RFC 3339 UTC timestamp with Z.

tostring date-time required

RFC 3339 UTC timestamp with Z.

Changes

No recorded changes to this operation across all 1 revision of this API.