curl --request POST \
--url https://api.select.dev/v2/metrics/bigquery-commitment-scopes/query \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-tenant-id: <x-tenant-id>' \
--data '
{
"measures": [
"total_cost",
"held_cost",
"autoscale_cost",
"committed_slots",
"baseline_slots",
"commitment_coverage_percent"
],
"dimensions": [
"commitment_scope_id",
"admin_project_id",
"region",
"edition"
],
"filter_expression": {
"operator": "and",
"filters": [
{
"field": "day",
"operator": "in range",
"value": "30D"
}
]
},
"sort": [
{
"field": "total_cost",
"direction": "desc"
}
],
"limit": 1000
}
'{
"items": [
{}
],
"page_token": "<string>",
"row_count": 123,
"sql": "<string>"
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "<string>",
"retryable": true,
"type": "about:blank",
"details": [
{}
]
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "<string>",
"retryable": true,
"type": "about:blank",
"details": [
{}
]
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "<string>",
"retryable": true,
"type": "about:blank",
"details": [
{}
]
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "<string>",
"retryable": true,
"type": "about:blank",
"details": [
{}
]
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "<string>",
"retryable": true,
"type": "about:blank",
"details": [
{}
]
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "<string>",
"retryable": true,
"type": "about:blank",
"details": [
{}
]
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "<string>",
"retryable": true,
"type": "about:blank",
"details": [
{}
]
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "<string>",
"retryable": true,
"type": "about:blank",
"details": [
{}
]
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "<string>",
"retryable": true,
"type": "about:blank",
"details": [
{}
]
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "<string>",
"retryable": true,
"type": "about:blank",
"details": [
{}
]
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "<string>",
"retryable": true,
"type": "about:blank",
"details": [
{}
]
}Query BigQuery capacity commitments by scope
One row per commitment scope: an administration project, region and edition, the boundary BigQuery draws around shared slot capacity. Carries both what the scope holds today and what it was billed over the requested range, which a date filter must bound.
Returns one row per combination of the requested dimensions, carrying the requested measures. Each row is keyed by dimension and measure name. row_count is the number of rows in items: results are not paginated, so an aggregation with more rows than limit is cut short at limit rather than continued under a page_token. Send X-Team-Id to evaluate the query as a team you belong to; rows are then limited to what that team’s roles reach.
Use this route to compare commitment scopes: what capacity each scope holds now, and what it billed in a period. A capacity commitment is a purchase of slots for a fixed term. A reservation is a pool of slots that jobs run on. A scope is one administration project, region and edition: a commitment covers only the reservations in its own scope. For a time series, use bigquery-commitment-scope-days. For each purchase, use bigquery-commitments. For the slots of one reservation, use bigquery-reservation-timeline.
Put a day range in the top-level and node, as two bounds or as in range. Without it, the route returns 422. Do not name day as a dimension. The range bounds the billed measures: total_cost (the dollar cost), held_cost, autoscale_cost and the *_slot_s slot-seconds. It does not bound the holdings (committed_slots, commitment_count, baseline_slots), which show the current state. annualized_committed_spend and annualized_uncommitted_cost are yearly run-rates, not spend in the period.
curl --request POST \
--url https://api.select.dev/v2/metrics/bigquery-commitment-scopes/query \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-tenant-id: <x-tenant-id>' \
--data '
{
"measures": [
"total_cost",
"held_cost",
"autoscale_cost",
"committed_slots",
"baseline_slots",
"commitment_coverage_percent"
],
"dimensions": [
"commitment_scope_id",
"admin_project_id",
"region",
"edition"
],
"filter_expression": {
"operator": "and",
"filters": [
{
"field": "day",
"operator": "in range",
"value": "30D"
}
]
},
"sort": [
{
"field": "total_cost",
"direction": "desc"
}
],
"limit": 1000
}
'{
"items": [
{}
],
"page_token": "<string>",
"row_count": 123,
"sql": "<string>"
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "<string>",
"retryable": true,
"type": "about:blank",
"details": [
{}
]
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "<string>",
"retryable": true,
"type": "about:blank",
"details": [
{}
]
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "<string>",
"retryable": true,
"type": "about:blank",
"details": [
{}
]
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "<string>",
"retryable": true,
"type": "about:blank",
"details": [
{}
]
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "<string>",
"retryable": true,
"type": "about:blank",
"details": [
{}
]
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "<string>",
"retryable": true,
"type": "about:blank",
"details": [
{}
]
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "<string>",
"retryable": true,
"type": "about:blank",
"details": [
{}
]
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "<string>",
"retryable": true,
"type": "about:blank",
"details": [
{}
]
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "<string>",
"retryable": true,
"type": "about:blank",
"details": [
{}
]
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "<string>",
"retryable": true,
"type": "about:blank",
"details": [
{}
]
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "<string>",
"retryable": true,
"type": "about:blank",
"details": [
{}
]
}Authorizations
Organization API key (sl_…).
Headers
Act as this team: rows are limited to what the team's roles reach instead of the caller's own. The caller must be a member of the team or hold the organization-wide permission the route requires.
The organization ID the request is scoped to.
Body
Aggregate BigQuery capacity commitments by scope.
A scope is one administration project, region and edition, the boundary BigQuery draws around shared capacity. A commitment covers only reservations of its own edition in its own administration project and region, and idle slots are lent within exactly that boundary, so capacity never pools across scopes and each is priced on its own.
Group by commitment_scope_id for one row per scope, or omit dimensions for
the organization's totals.
Measures come in two kinds. Holdings (committed_slots, commitment_count,
baseline_slots) describe what is held right now and do not move with the
date range. Everything billed (costs, slot-seconds, utilization) covers the
requested range. The two disagree on a recent purchase: a commitment counts
as held from the moment it is signed, while the capacity it buys reaches the
bill later.
A date range is required. It bounds the billed measures, and without it they would silently cover all of history.
Aggregates to compute over the matching rows.
Show child attributes
Show child attributes
Columns to group the aggregates by. Each is returned on every row.
Show child attributes
Show child attributes
An and/or tree of predicates over dimensions, applied before aggregation. Omit to match every row the caller can see.
Show child attributes
Show child attributes
Predicates over measures, applied after aggregation.
- InFilter[OrgBigQueryCommitmentScopeMeasures]
- ArrayContainsFilter[OrgBigQueryCommitmentScopeMeasures]
- IsFilter[OrgBigQueryCommitmentScopeMeasures]
- LikeFilter[OrgBigQueryCommitmentScopeMeasures]
- MultiLikeFilter[OrgBigQueryCommitmentScopeMeasures]
- EqFilter[OrgBigQueryCommitmentScopeMeasures]
- FilterExpression[OrgBigQueryCommitmentScopeMeasures]
- InRelativeDateRangeFilter[OrgBigQueryCommitmentScopeMeasures]
Show child attributes
Show child attributes
Ordering applied to the aggregated rows.
Show child attributes
Show child attributes
Maximum rows to return. Omit for no limit. An aggregation that produces more rows than this is silently cut short at the limit.
x >= 1Return the SQL that produced the rows alongside them, for inspecting how a result was computed. Not every query endpoint publishes its SQL; where it does not, the field stays null.
Reshape the result so the named dimensions become columns rather than rows. Each remaining dimension yields one row, carrying a pivot_data object keyed by the pivoted dimension values. Every name in pivot.on must also appear in dimensions.
Show child attributes
Show child attributes
Return the result as a tree rather than a flat list, grouping the named dimensions into one level per tree depth. One request fetches the top level; a follow-up naming rollup.parent_paths fetches the children of the nodes expanded so far, so a deep hierarchy is read a level at a time. Every name in rollup.dimensions must also appear in dimensions.
Show child attributes
Show child attributes
Aggregate the matching rows. Set false to return the underlying rows as they are, projecting the requested dimensions with no grouping — a listing rather than an aggregation. It is honored only for a request that asks for no measures and no measure_filters, since an aggregate has to group to be computable; limit, when set, bounds the rows returned either way.
Response
Successful Response
Opaque cursor for the next page; empty/absent on the last page.
Best-effort total for the filtered result set; may be null when expensive.
The SQL that produced these rows, returned only when the request asks for it. Database and schema names are left as placeholders. Null when the request did not ask for it, or when this endpoint does not publish its SQL.