Skip to main content
GET
Retrieve sandbox usage

Authorizations

Authorization
string
header
required

A gbr_pat_ access token. Scopes are recorded on the token when it is minted.

Query Parameters

root
string

Aggregate the whole tree under this session instead of the one session. The id must match the path, which is how a crew total says which crew it is.

Response

How much sandbox time this session — or the crew under it — has used.

Sandbox time, split by how settled it is. One number would have to merge a live estimate with a reconciled charge and invent a duration for an interval nobody can account for, so it is several.

object
string
required
Allowed value: "session.usage"
session_id
string
required
scope
enum<string>
required

tree when ?root= asked for the whole crew.

Available options:
session,
tree
as_of
integer
required

Unix ms. A running sandbox is counted up to this moment, so the number moves until it stops.

sandbox_seconds
integer
required

Everything that can be accounted for: settled, pending reconciliation, and still running. Not a bill.

chargeable_seconds
integer
required

The reconciled subset — the part the provider has confirmed. Always less than or equal to sandbox_seconds.

needs_review_intervals
integer
required

Intervals whose duration is not known. Reported as a count on purpose: inventing seconds for them would make the total look settled when it is not.

sessions
integer

How many sessions this total covers.

intervals
integer

How many intervals went into this, excluding ones marked not billable at all.