Skip to main content
GET
Error

Authorizations

X-API-Key
string
header
required
X-Tenant-Id
string
header
required

Query Parameters

start_time
string<date-time>
required

Inclusive RFC3339 start time

end_time
string<date-time>
required

Exclusive RFC3339 end time; the range must not exceed 31 days

resource_type
enum<string>

Resource type filter

Available options:
SANDBOX,
SNAPSHOT
resource_ids
string[]

Resource UUID filter; repeat this parameter up to 100 times

page_size
integer
default:20

Maximum rows to return

Required range: 1 <= x <= 100
granularity
enum<string>
default:HOUR

HOUR returns hourly buckets. RESOURCE sums each resource over the requested interval and sets period_start to start_time.

Available options:
HOUR,
RESOURCE
cursor
string

Opaque pagination cursor

include_totals
boolean
default:false

Include usage totals across the filtered interval (RESOURCE only). Omitted when unrestricted resource access cannot be verified or the service does not support totals. CLI: use --format raw to show this summary.

include_daily
boolean
default:false

Include bounded daily physical usage for the top 10 resources per metric and Other. Requires RESOURCE and include_totals. Omitted when unrestricted access or service support is unavailable. CLI: use --format raw to show this summary.

Response

OK

items
object[]
required
next_cursor
string | null
required
daily
object

Daily usage over the full filtered interval, independent of pagination. Omitted unless requested, supported, and unrestricted resource access is verified.

totals
object

Totals cover the entire filtered interval, independently of the cursor. Omitted unless requested and unrestricted resource access is verified.