curl --request POST \
  --url https://api.select.dev/v2/metrics/bigquery-commitments/query \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-tenant-id: <x-tenant-id>' \
  --data '
{
  "measures": [
    "slot_count"
  ],
  "dimensions": [
    "capacity_commitment_id",
    "commitment_scope_id",
    "admin_project_id",
    "region",
    "edition",
    "commitment_plan",
    "renewal_plan",
    "state",
    "commitment_start_time",
    "commitment_end_time"
  ],
  "filter_expression": {
    "operator": "and",
    "filters": [
      {
        "field": "is_in_effect",
        "operator": "=",
        "value": true
      }
    ]
  },
  "sort": [
    {
      "field": "commitment_end_time",
      "direction": "asc"
    }
  ],
  "limit": 1000
}
'

{
  "items": [
    {}
  ],
  "page_token": "<string>",
  "row_count": 123,
  "sql": "<string>"
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

metrics

Query BigQuery capacity commitments

One row per capacity commitment, each with its own term, rate and end date. Group by capacity_commitment_id for the inventory, or filter by commitment_scope_id for what one scope holds.

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 list BigQuery capacity commitments: one row per purchase of slots, with its plan, size, state and term dates. This route is a snapshot of the commitments now. It has no day field, and it has no cost in a period. For what a commitment scope billed, use bigquery-commitment-scopes or bigquery-commitment-scope-days. For the slots that reservations used, use bigquery-reservation-timeline. The route also keeps terminated commitments (state CANCELLED or FAILED). The SELECT app shows them, but to count or total the slots that are held now, filter on is_in_effect = true. annualized_cost is slot_count at today’s list rate for the plan over a year. It is a run-rate, and it is not what the commitment bills.

POST

metrics

bigquery-commitments

query

curl --request POST \
  --url https://api.select.dev/v2/metrics/bigquery-commitments/query \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-tenant-id: <x-tenant-id>' \
  --data '
{
  "measures": [
    "slot_count"
  ],
  "dimensions": [
    "capacity_commitment_id",
    "commitment_scope_id",
    "admin_project_id",
    "region",
    "edition",
    "commitment_plan",
    "renewal_plan",
    "state",
    "commitment_start_time",
    "commitment_end_time"
  ],
  "filter_expression": {
    "operator": "and",
    "filters": [
      {
        "field": "is_in_effect",
        "operator": "=",
        "value": true
      }
    ]
  },
  "sort": [
    {
      "field": "commitment_end_time",
      "direction": "asc"
    }
  ],
  "limit": 1000
}
'

{
  "items": [
    {}
  ],
  "page_token": "<string>",
  "row_count": 123,
  "sql": "<string>"
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

Authorizations

Authorization

string

header

required

Organization API key (sl_…).

Headers

x-team-id

string<uuid> | null

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.

x-tenant-id

string

required

The organization ID the request is scoped to.

Body

application/json

List BigQuery capacity commitments, one row per purchase.

Each commitment is its own contract: its slots are locked until its own end date and its renewal plan is its own field, so they are listed rather than summed. Group by capacity_commitment_id for the inventory, and filter by commitment_scope_id for the commitments one scope holds.

commitment_start_time and commitment_end_time are null for a commitment older than the change log reaches. That is unknown rather than absent: a missing end date is not the same as no expiry.

plan_list_rate_per_slot_hour is null when the price card publishes no rate for the plan, which is its own answer rather than a zero.

measures

(SemiStructuredMeasure[OrgBigQueryCommitmentDimensions] · object | enum<string>)[]

Aggregates to compute over the matching rows.

Show child attributes

dimensions

(SemiStructuredDimension[OrgBigQueryCommitmentDimensions] · object | enum<string>)[]

Columns to group the aggregates by. Each is returned on every row.

Show child attributes

filter_expression

FilterExpression[Union[SemiStructuredDimension[OrgBigQueryCommitmentDimensions], OrgBigQueryCommitmentDimensions]] · object | null

An and/or tree of predicates over dimensions, applied before aggregation. Omit to match every row the caller can see.

Show child attributes

measure_filters

(InFilter[OrgBigQueryCommitmentMeasures] · object | ArrayContainsFilter[OrgBigQueryCommitmentMeasures] · object | IsFilter[OrgBigQueryCommitmentMeasures] · object | LikeFilter[OrgBigQueryCommitmentMeasures] · object | MultiLikeFilter[OrgBigQueryCommitmentMeasures] · object | EqFilter[OrgBigQueryCommitmentMeasures] · object | FilterExpression[OrgBigQueryCommitmentMeasures] · object | InRelativeDateRangeFilter[OrgBigQueryCommitmentMeasures] · object)[]

Predicates over measures, applied after aggregation.

InFilter[OrgBigQueryCommitmentMeasures]
ArrayContainsFilter[OrgBigQueryCommitmentMeasures]
IsFilter[OrgBigQueryCommitmentMeasures]
LikeFilter[OrgBigQueryCommitmentMeasures]
MultiLikeFilter[OrgBigQueryCommitmentMeasures]
EqFilter[OrgBigQueryCommitmentMeasures]
FilterExpression[OrgBigQueryCommitmentMeasures]
InRelativeDateRangeFilter[OrgBigQueryCommitmentMeasures]

Show child attributes

sort

Sort[OrgBigQueryCommitmentMeasures, OrgBigQueryCommitmentDimensions] · object[]

Ordering applied to the aggregated rows.

Show child attributes

limit

integer | null

Maximum rows to return. Omit for no limit. An aggregation that produces more rows than this is silently cut short at the limit.

Required range: x >= 1

return_sql

boolean

default:false

Return 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.

pivot

PivotConfig · object | 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

rollup

GroupRollupConfig · object | null

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

aggregate

boolean

default:true

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

items

Items · object[]

required

page_token

string | null

Opaque cursor for the next page; empty/absent on the last page.

row_count

integer | null

Best-effort total for the filtered result set; may be null when expensive.

sql

string | null

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.

Get Started

Endpoints

Query BigQuery capacity commitments

Authorizations

Headers

Body

Response