> ## Documentation Index > Fetch the complete documentation index at: https://api-docs.select.dev/llms.txt > Use this file to discover all available pages before exploring further. # Query Databricks APC metrics > One row per group of Automated Performance Cluster utilization samples, carrying worker and scheduler signals polled from live clusters over the requested period. 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 for the Spark signals that SELECT Automated Savings reads from Databricks all-purpose clusters (APC). The service polls each cluster approximately every 30 seconds. It records the active and pending tasks, the worker count and the autoscale target. Data exists only for the clusters that have Automated Savings on, and only for the time that it was on. For other clusters, the route returns no rows. This route has no `day` field: filter and group on `minute`. The measures are averages of the polls in each group, not totals. There is no cost measure: for spend and realized savings, use `databricks-clusters`. For CPU and memory, use `databricks-cluster-node-metrics`. ## OpenAPI ````yaml https://api.select.dev/v2/openapi.json post /metrics/databricks-apc-metrics/query openapi: 3.1.0 info: title: SELECT API (v2) version: 0.1.0 servers: - url: https://api.select.dev/v2 description: SELECT API v2 security: [] tags: - name: metrics description: >- Query cost and usage data across Snowflake, BigQuery, Databricks and Tableau. Each route is `POST /v2/metrics//query` for one semantic model. Every route takes the same body shape and returns the same response shape. Each route page gives guidance on when to use the route, and worked examples. ## Body shape | Field | Meaning | | --- | --- | | `measures` | Aggregates to compute, for example `sum_spend`. | | `dimensions` | Fields to group by. Each one is returned on every row. | | `filter_expression` | An `and`/`or` tree of filters on dimensions, applied before aggregation. | | `measure_filters` | Filters on measures, applied after aggregation. | | `sort` | The order of the rows: `[{"field": "sum_spend", "direction": "desc"}]`. | | `limit` | The maximum number of rows. Results are not paginated: `limit` cuts the result short, and there is no next page. Omit `limit` to get all rows. | | `aggregate` | Set `false` to list the rows with no grouping. See "Listing rows". | v2 accepts only `filter_expression`. The body refuses the legacy `filters` list. ## Filter on dates Filter on the `day` field. Use two filters (both bounds are inclusive): ```json {"operator": "and", "filters": [ {"field": "day", "operator": ">=", "value": "2026-08-01"}, {"field": "day", "operator": "<=", "value": "2026-08-31"}], "limit": 1000} ``` Or use one relative filter: `{"field": "day", "operator": "in range", "value": "30D"}`. The values are `{N}D` and `{N}M` (the last N days or months, today included), `WTD`, `MTD`, `QTD`, `YTD`, and `LMTD` (the whole previous calendar month). - Do not filter on `hour`, `week`, `month` or `quarter` to bound a range. Filter on `day`, and use the coarser fields as dimensions. - A timestamp such as `start_time <= "2026-08-31"` compares to midnight and drops most of that day. Use `day`, or `start_time < "2026-09-01"`. - A snapshot route (for example `snowflake-storage-summary`) describes the current state, and a `day` filter does not bound its size and cost fields. On routes that join the snapshot to activity, `day` bounds only the activity fields. Each route page says which fields these are. ## Which measure is cost - `sum_spend` (or `spend`, or `cost` on some routes) is the dollar cost in the filtered period. Use it for "how much did we spend". - `*_annualized` measures extend the spend of the filtered period to a year: a `7D` range gives that week's spend times 365 / 7. They are projections, not spend. - On snapshot routes, `annual_cost`, `*_monthly_cost` and `*_annual_cost` are the current rate extended to a month or a year. A date range does not bound them. - Do not present any of these run-rates as spend in a period. - Databricks routes also give DBUs (for example `sum_task_usage`). DBUs are not dollars. The `spend` route is the consolidated cost of every platform. Use it for totals, trends and breakdowns by service. Use a platform route to explain what inside the platform caused the cost. ## Text values are case-sensitive Filter values must match the stored case. A value in the wrong case matches no rows, with no error. For example: - On `spend`, `connection_type` is `Snowflake`, `Bigquery` or `Databricks`, and `"snowflake"` matches nothing. - On `search`, `data-freshness` and `workload-metadata-suggestions`, `connection_type` is lowercase: `snowflake`, `bigquery`, `databricks`. - On `snowflake-workloads`, most `resource_type` values are lowercase keys (`query_pattern`, `dbt`), but the AI types are title case (`Cortex Analyst`). ## Usage groups A usage group set divides cost into named groups, such as departments or teams. To group by the groups of one set, name the set in `path`: ```json {"dimensions": [{"field": "usage_group", "path": ["Department"]}], "limit": 1000} ``` `path[0]` is the name of the set, not its ID. A plain `"usage_group"` dimension groups by every set at once. The same `{"field": ..., "path": [...]}` form reads keys of other semi-structured fields, for example workload metadata. ## Period over period Some routes publish `_previous_period`, `change_` and `percent_change_`. These measures need one bounded date range on `day`, at the top level of `filter_expression`: - Use two bounds on `day`, or one `in range` filter. Do not mix the two forms. - Do not nest the date filter in a sub-expression, and do not bound the range with `month` or `quarter`. - The previous period is the same number of days, just before the range. For `QTD` on 2026-09-28 (2026-07-01 to 2026-09-28, 90 days), the previous period is 2026-04-02 to 2026-06-30, not the previous calendar quarter. ## Listing rows Set `"aggregate": false` and name only `dimensions` to get the rows as they are, for example the individual queries that ran longer than ten minutes. If the body also names `measures` or `measure_filters`, the route aggregates, with no error. Always set a `limit` on a listing. ## Default scoping filters Some tables hold more than one kind of row, and the SELECT app filters to one kind by default. Each route page names these filters. For example: - `snowflake-query-patterns`: `{"field": "resource_type", "operator": "in", "values": ["query_pattern"]}`. `bigquery-query-patterns` filters `workload_type` to `bigquery_query_pattern`, and `databricks-query-patterns` filters `resource_type` to `databricks_query_pattern`. - `snowflake-dbt`: `{"field": "dbt_node_resource_type", "operator": "=", "value": "model"}`. Without it, tests, seeds and snapshots rank with models. The same filter applies to `bigquery-dbt-queries` and `databricks-dbt-queries`. ## Teams Send `X-Team-Id` to evaluate a query as a team you belong to. The rows are then limited to what the team's roles can reach. ## Which route answers which question | Question | Route | | --- | --- | | Total spend, spend trend, spend by platform, service or usage group | `spend` | | Most expensive Snowflake warehouses | `snowflake-workloads` (or `snowflake-warehouses` for metering spend) | | Warehouse utilization, idle spend, cluster usage | `snowflake-warehouses`, `snowflake-warehouse-clusters` | | Query latency, spillage and bytes scanned on a warehouse | `snowflake-warehouse-query-performance` | | Most expensive recurring queries | `snowflake-query-patterns` | | Individual queries | `snowflake-queries` | | Cost of dbt models, and of dbt runs | `snowflake-dbt`, `snowflake-dbt-invocations` | | Cost of tasks, stored procedures, dynamic tables | `snowflake-tasks`, `snowflake-stored-procedures`, `snowflake-dynamic-tables` | | Cost of BI tools (Looker, Mode, Hex, Sigma, Periscope, Tableau) | `snowflake-looker`, `snowflake-mode`, `snowflake-hex`, `snowflake-sigma`, `snowflake-periscope`, `tableau-queries` | | Cost of Fivetran, and of workloads defined by query tags | `snowflake-fivetran`, `snowflake-custom-workloads` | | Serverless, automatic clustering and Snowpipe cost | `snowflake-serverless`, `snowflake-automatic-clustering`, `snowflake-snowpipe` | | Storage cost in a period | `snowflake-storage`, `bigquery-storage-spend` | | Largest or unused tables now | `snowflake-storage-summary`, `bigquery-storage-summary` | | Which workloads read or write a table | `lineage-workloads`, `lineage-tables`, `lineage-edges` | | BigQuery cost by project, job or query pattern | `bigquery-projects`, `bigquery-jobs`, `bigquery-query-patterns` | | BigQuery reservations and commitments | `bigquery-reservation-timeline`, `bigquery-commitments`, `bigquery-commitment-scopes` | | Databricks cost by job, query, SQL warehouse or cluster | `databricks-jobs`, `databricks-queries`, `databricks-sql-warehouses`, `databricks-clusters` | | Savings from SELECT actions | `action-realized-savings` | | How current the data is | `data-freshness` | paths: /metrics/databricks-apc-metrics/query: post: tags: - metrics summary: Query Databricks APC metrics description: >- One row per group of Automated Performance Cluster utilization samples, carrying worker and scheduler signals polled from live clusters over the requested period. 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 for the Spark signals that SELECT Automated Savings reads from Databricks all-purpose clusters (APC). The service polls each cluster approximately every 30 seconds. It records the active and pending tasks, the worker count and the autoscale target. Data exists only for the clusters that have Automated Savings on, and only for the time that it was on. For other clusters, the route returns no rows. This route has no `day` field: filter and group on `minute`. The measures are averages of the polls in each group, not totals. There is no cost measure: for spend and realized savings, use `databricks-clusters`. For CPU and memory, use `databricks-cluster-node-metrics`. operationId: >- query_databricks_apc_metrics_route_metrics_databricks_apc_metrics_query_post parameters: - name: x-team-id in: header required: false schema: anyOf: - type: string format: uuid - type: 'null' description: >- 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. title: X-Team-Id description: >- 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. - name: x-tenant-id in: header required: true schema: type: string description: The organization ID the request is scoped to. title: X-Tenant-Id description: The organization ID the request is scoped to. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DatabricksApcMetricsQuery' examples: workers-against-spark-load-for-one-cluster-by-minute-today: summary: Workers against Spark load for one cluster, by minute, today description: >- - `minute` is the only date field. `in range` on `minute` works the same as on `day`. - `avg_target_workers` is the worker count that Databricks autoscaling asks for. `avg_num_workers` is the count that runs. - Workers that run while `avg_active_tasks` and `avg_pending_tasks` are 0 are idle capacity. - `avg_pending_stage_tasks` averages the number of pending stages, not tasks. value: measures: - avg_num_workers - avg_target_workers - avg_active_tasks - avg_pending_tasks - avg_pending_stage_tasks dimensions: - minute filter_expression: operator: and filters: - field: minute operator: in range value: 1D - field: cluster_id operator: '=' value: 0123-456789-abcdefgh sort: - field: minute direction: asc limit: 1000 average-load-on-each-monitored-cluster-last-7-days: summary: Average load on each monitored cluster, last 7 days description: >- - `avg_flux_pressure` is tasks created per minute minus tasks completed per minute. A positive value means that work collects in a queue. - `avg_creation_rate` and `avg_completion_rate` are tasks per minute. value: measures: - avg_num_workers - avg_active_tasks - avg_flux_pressure - avg_creation_rate - avg_completion_rate dimensions: - cluster_id filter_expression: operator: and filters: - field: minute operator: in range value: 7D sort: - field: avg_num_workers direction: desc limit: 1000 responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/QueryResponse_dict_str__Any__' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '405': $ref: '#/components/responses/MethodNotAllowed' '408': $ref: '#/components/responses/RequestTimeout' '409': $ref: '#/components/responses/Conflict' '422': $ref: '#/components/responses/ValidationFailed' '429': $ref: '#/components/responses/RateLimited' '500': $ref: '#/components/responses/InternalError' '503': $ref: '#/components/responses/ServiceUnavailable' security: - HTTPBearer: [] components: schemas: DatabricksApcMetricsQuery: properties: measures: items: anyOf: - $ref: >- #/components/schemas/SemiStructuredMeasure_ApcClusterMetricsDimensions_ - $ref: '#/components/schemas/ApcClusterMetricsMeasures' type: array title: Measures description: Aggregates to compute over the matching rows. dimensions: items: anyOf: - $ref: >- #/components/schemas/SemiStructuredDimension_ApcClusterMetricsDimensions_ - $ref: '#/components/schemas/ApcClusterMetricsDimensions' type: array title: Dimensions description: Columns to group the aggregates by. Each is returned on every row. filter_expression: anyOf: - $ref: >- #/components/schemas/FilterExpression_Union_SemiStructuredDimension_ApcClusterMetricsDimensions___ApcClusterMetricsDimensions__ - type: 'null' description: >- An `and`/`or` tree of predicates over dimensions, applied before aggregation. Omit to match every row the caller can see. measure_filters: items: anyOf: - $ref: '#/components/schemas/InFilter_ApcClusterMetricsMeasures_' - $ref: >- #/components/schemas/ArrayContainsFilter_ApcClusterMetricsMeasures_ - $ref: '#/components/schemas/IsFilter_ApcClusterMetricsMeasures_' - $ref: '#/components/schemas/LikeFilter_ApcClusterMetricsMeasures_' - $ref: >- #/components/schemas/MultiLikeFilter_ApcClusterMetricsMeasures_ - $ref: '#/components/schemas/EqFilter_ApcClusterMetricsMeasures_' - $ref: >- #/components/schemas/FilterExpression_ApcClusterMetricsMeasures_ - $ref: >- #/components/schemas/InRelativeDateRangeFilter_ApcClusterMetricsMeasures_ type: array title: Measure Filters description: Predicates over measures, applied after aggregation. sort: items: $ref: >- #/components/schemas/Sort_ApcClusterMetricsMeasures_ApcClusterMetricsDimensions_ type: array title: Sort description: Ordering applied to the aggregated rows. limit: anyOf: - type: integer minimum: 1 - type: 'null' title: Limit description: >- Maximum rows to return. Omit for no limit. An aggregation that produces more rows than this is silently cut short at the limit. return_sql: type: boolean title: Return Sql description: >- 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. default: false pivot: anyOf: - $ref: '#/components/schemas/PivotConfig' - type: 'null' description: >- 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`. rollup: anyOf: - $ref: '#/components/schemas/GroupRollupConfig' - type: 'null' description: >- 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`. aggregate: type: boolean title: Aggregate description: >- 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. default: true additionalProperties: false type: object title: DatabricksApcMetricsQuery description: Aggregate Automated Performance Cluster utilization samples. QueryResponse_dict_str__Any__: properties: items: items: additionalProperties: true type: object type: array title: Items page_token: anyOf: - type: string - type: 'null' title: Page Token description: Opaque cursor for the next page; empty/absent on the last page. row_count: anyOf: - type: integer - type: 'null' title: Row Count description: >- Best-effort total for the filtered result set; may be null when expensive. sql: anyOf: - type: string - type: 'null' title: Sql description: >- 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. type: object required: - items title: QueryResponse[dict[str, Any]] SemiStructuredMeasure_ApcClusterMetricsDimensions_: properties: aggregate_function: type: string const: array_unique_agg title: Aggregate Function dimension: $ref: >- #/components/schemas/SemiStructuredDimension_ApcClusterMetricsDimensions_ type: object required: - aggregate_function - dimension title: SemiStructuredMeasure[ApcClusterMetricsDimensions] ApcClusterMetricsMeasures: type: string enum: - avg_active_tasks - avg_pending_tasks - avg_pending_stage_tasks - avg_num_workers - avg_target_workers - avg_creation_rate - avg_completion_rate - avg_flux_pressure SemiStructuredDimension_ApcClusterMetricsDimensions_: properties: field: $ref: '#/components/schemas/ApcClusterMetricsDimensions' path: items: type: string type: array title: Path type: object required: - field - path title: SemiStructuredDimension[ApcClusterMetricsDimensions] ApcClusterMetricsDimensions: type: string enum: - connection_type - minute - cluster_id FilterExpression_Union_SemiStructuredDimension_ApcClusterMetricsDimensions___ApcClusterMetricsDimensions__: properties: operator: type: string enum: - and - or title: Operator filters: items: anyOf: - $ref: >- #/components/schemas/FilterExpression_Union_SemiStructuredDimension_ApcClusterMetricsDimensions___ApcClusterMetricsDimensions__ - $ref: >- #/components/schemas/EqFilter_Union_SemiStructuredDimension_ApcClusterMetricsDimensions___ApcClusterMetricsDimensions__ - $ref: >- #/components/schemas/InFilter_Union_SemiStructuredDimension_ApcClusterMetricsDimensions___ApcClusterMetricsDimensions__ - $ref: >- #/components/schemas/ArrayContainsFilter_Union_SemiStructuredDimension_ApcClusterMetricsDimensions___ApcClusterMetricsDimensions__ - $ref: >- #/components/schemas/IsFilter_Union_SemiStructuredDimension_ApcClusterMetricsDimensions___ApcClusterMetricsDimensions__ - $ref: >- #/components/schemas/LikeFilter_Union_SemiStructuredDimension_ApcClusterMetricsDimensions___ApcClusterMetricsDimensions__ - $ref: >- #/components/schemas/MultiLikeFilter_Union_SemiStructuredDimension_ApcClusterMetricsDimensions___ApcClusterMetricsDimensions__ - $ref: >- #/components/schemas/InRelativeDateRangeFilter_Union_SemiStructuredDimension_ApcClusterMetricsDimensions___ApcClusterMetricsDimensions__ type: array title: Filters component_type: anyOf: - type: string const: Resource Filter - type: 'null' title: Component Type type: object required: - operator - filters title: >- FilterExpression[Union[SemiStructuredDimension[ApcClusterMetricsDimensions], ApcClusterMetricsDimensions]] InFilter_ApcClusterMetricsMeasures_: properties: field: $ref: '#/components/schemas/ApcClusterMetricsMeasures' not: type: boolean title: Not default: false values: items: anyOf: - $ref: '#/components/schemas/EqValue' - $ref: '#/components/schemas/DictValue' type: array title: Values operator: type: string enum: - in - not in title: Operator type: object required: - field - values - operator title: InFilter[ApcClusterMetricsMeasures] ArrayContainsFilter_ApcClusterMetricsMeasures_: properties: field: $ref: '#/components/schemas/ApcClusterMetricsMeasures' not: type: boolean title: Not default: false values: items: anyOf: - $ref: '#/components/schemas/EqValue' - $ref: '#/components/schemas/DictValue' type: array title: Values operator: type: string const: array_contains title: Operator type: object required: - field - values - operator title: ArrayContainsFilter[ApcClusterMetricsMeasures] IsFilter_ApcClusterMetricsMeasures_: properties: field: $ref: '#/components/schemas/ApcClusterMetricsMeasures' not: type: boolean title: Not default: false value: type: 'null' title: Value operator: type: string enum: - is - is not title: Operator type: object required: - field - operator title: IsFilter[ApcClusterMetricsMeasures] LikeFilter_ApcClusterMetricsMeasures_: properties: field: $ref: '#/components/schemas/ApcClusterMetricsMeasures' not: type: boolean title: Not default: false value: type: string title: Value operator: type: string enum: - ilike - startswith - array_contains_prefix - array_contains_substring title: Operator type: object required: - field - value - operator title: LikeFilter[ApcClusterMetricsMeasures] MultiLikeFilter_ApcClusterMetricsMeasures_: properties: field: $ref: '#/components/schemas/ApcClusterMetricsMeasures' not: type: boolean title: Not default: false values: items: type: string type: array title: Values operator: type: string enum: - ilike - startswith title: Operator type: object required: - field - values - operator title: MultiLikeFilter[ApcClusterMetricsMeasures] EqFilter_ApcClusterMetricsMeasures_: properties: field: $ref: '#/components/schemas/ApcClusterMetricsMeasures' not: type: boolean title: Not default: false value: anyOf: - $ref: '#/components/schemas/EqValue' - $ref: '#/components/schemas/DictValue' title: Value operator: type: string enum: - '>' - '>=' - < - <= - '=' - '!=' title: Operator type: object required: - field - value - operator title: EqFilter[ApcClusterMetricsMeasures] FilterExpression_ApcClusterMetricsMeasures_: properties: operator: type: string enum: - and - or title: Operator filters: items: anyOf: - $ref: >- #/components/schemas/FilterExpression_ApcClusterMetricsMeasures_ - $ref: '#/components/schemas/EqFilter_ApcClusterMetricsMeasures_' - $ref: '#/components/schemas/InFilter_ApcClusterMetricsMeasures_' - $ref: >- #/components/schemas/ArrayContainsFilter_ApcClusterMetricsMeasures_ - $ref: '#/components/schemas/IsFilter_ApcClusterMetricsMeasures_' - $ref: '#/components/schemas/LikeFilter_ApcClusterMetricsMeasures_' - $ref: >- #/components/schemas/MultiLikeFilter_ApcClusterMetricsMeasures_ - $ref: >- #/components/schemas/InRelativeDateRangeFilter_ApcClusterMetricsMeasures_ type: array title: Filters component_type: anyOf: - type: string const: Resource Filter - type: 'null' title: Component Type type: object required: - operator - filters title: FilterExpression[ApcClusterMetricsMeasures] InRelativeDateRangeFilter_ApcClusterMetricsMeasures_: properties: field: $ref: '#/components/schemas/ApcClusterMetricsMeasures' not: type: boolean title: Not default: false value: type: string title: Value operator: type: string enum: - in range - not in range title: Operator type: object required: - field - value - operator title: InRelativeDateRangeFilter[ApcClusterMetricsMeasures] Sort_ApcClusterMetricsMeasures_ApcClusterMetricsDimensions_: properties: field: anyOf: - $ref: >- #/components/schemas/SemiStructuredDimension_ApcClusterMetricsDimensions_ - $ref: '#/components/schemas/ApcClusterMetricsDimensions' - $ref: >- #/components/schemas/SemiStructuredMeasure_ApcClusterMetricsDimensions_ - $ref: '#/components/schemas/ApcClusterMetricsMeasures' title: Field direction: type: string enum: - asc - desc title: Direction column_key: anyOf: - type: string - type: 'null' title: Column Key type: object required: - field - direction title: Sort[ApcClusterMetricsMeasures, ApcClusterMetricsDimensions] PivotConfig: properties: 'on': items: type: string type: array minItems: 1 title: 'On' limit: type: integer maximum: 500 minimum: 1 title: Limit description: Maximum number of pivot columns. Ignored when `keys` is set. default: 50 other: type: boolean title: Other description: >- When true, values outside the top-N (or pinned `keys`) are aggregated into an overflow bucket under the reserved pivot_data key '$__other__'. The sentinel avoids colliding with a real dimension value named 'Other'; map it to a display label. default: false keys: anyOf: - items: type: string type: array maxItems: 500 minItems: 1 - type: 'null' title: Keys description: >- Pinned column keys: when set, results bucket into exactly these column keys instead of a computed top-N (`limit` is ignored), so a follow-up query can reproduce a prior response's column set. Keys use the same JSON-array-string form pivot_data emits (e.g. '["wh_1"]'). With `other`, values outside the keys fold into the '$__other__' overflow bucket. sort: anyOf: - $ref: '#/components/schemas/PivotSort' - type: 'null' description: >- Orders pivot columns by this `on` dimension; also drives top-N column selection instead of the default measure-based selection. type: object required: - 'on' title: PivotConfig description: Configuration for pivoting query results using OBJECT_AGG. GroupRollupConfig: properties: dimensions: items: items: type: string type: array type: array minItems: 1 title: Dimensions parent_paths: anyOf: - items: items: additionalProperties: true type: object type: array type: array - type: 'null' title: Parent Paths description: >- Expanded parent nodes to fetch children for, scoping each fetch to its own subtree instead of an entire depth. Each entry is one node's path: an ordered list of segments, where segment i maps every dimension name in `dimensions[i]` to that node's value at that level. A path's length is the depth of the children being requested — e.g. a one-segment path (naming `dimensions[0]`'s dimensions) requests that node's depth-1 children. All entries in one request must share the same length. per_group_limit: type: integer maximum: 1000 minimum: 1 title: Per Group Limit description: Top-N children per parent, applied via QUALIFY row_number(). default: 50 other: type: boolean title: Other description: >- When true, each parent's children beyond the top `per_group_limit` are folded into one remainder row per parent, flagged via the reserved `__group_other`/`__group_other_count` output columns. Only additive measures (plain sums, or percent-of-total windows over a sum) are re-aggregated into the remainder row; other measures come back null there rather than risk a wrong number. Not supported together with `pivot`. default: false type: object required: - dimensions title: GroupRollupConfig description: |- Configuration for server-side nested-group rollup. Declares an ordered tree hierarchy over a subset of the query's dimensions. Each level corresponds to a single tree depth but may bundle several dimensions together (e.g. a "table" column that depends on ["database_name", "schema_name", "table_name"]). Each depth is rendered as an independent, dimension-truncated clone of the query (see rollup_query.py) and disambiguated by a reserved `__group_depth` column. With `other`, per-parent remainder rows add `__group_depth`'s siblings `__group_other`/`__group_other_count`. Without `parent_paths`, the request renders depth 0 only (root groups). With `parent_paths`, a single child depth is rendered scoped to specific already-expanded parent nodes. ProblemDetail: additionalProperties: true description: >- RFC 9457-style error payload, served as ``application/problem+json``. ``code`` is the stable, machine-readable identifier — consumers branch on it, never on ``title``. ``type`` stays ``about:blank``: we keep no per-error documentation pages. There is no ``instance``/request-id member (we don't run access logs). See the flat error-code catalogue in §4 of the standards doc. properties: type: default: about:blank title: Type type: string title: type: string title: Title status: title: Status type: integer detail: title: Detail type: string code: title: Code type: string retryable: title: Retryable type: boolean details: anyOf: - items: additionalProperties: true type: object type: array - type: 'null' default: null title: Details required: - title - status - detail - code - retryable title: ProblemDetail type: object EqFilter_Union_SemiStructuredDimension_ApcClusterMetricsDimensions___ApcClusterMetricsDimensions__: properties: field: anyOf: - $ref: >- #/components/schemas/SemiStructuredDimension_ApcClusterMetricsDimensions_ - $ref: '#/components/schemas/ApcClusterMetricsDimensions' title: Field not: type: boolean title: Not default: false value: anyOf: - $ref: '#/components/schemas/EqValue' - $ref: '#/components/schemas/DictValue' title: Value operator: type: string enum: - '>' - '>=' - < - <= - '=' - '!=' title: Operator type: object required: - field - value - operator title: >- EqFilter[Union[SemiStructuredDimension[ApcClusterMetricsDimensions], ApcClusterMetricsDimensions]] InFilter_Union_SemiStructuredDimension_ApcClusterMetricsDimensions___ApcClusterMetricsDimensions__: properties: field: anyOf: - $ref: >- #/components/schemas/SemiStructuredDimension_ApcClusterMetricsDimensions_ - $ref: '#/components/schemas/ApcClusterMetricsDimensions' title: Field not: type: boolean title: Not default: false values: items: anyOf: - $ref: '#/components/schemas/EqValue' - $ref: '#/components/schemas/DictValue' type: array title: Values operator: type: string enum: - in - not in title: Operator type: object required: - field - values - operator title: >- InFilter[Union[SemiStructuredDimension[ApcClusterMetricsDimensions], ApcClusterMetricsDimensions]] ArrayContainsFilter_Union_SemiStructuredDimension_ApcClusterMetricsDimensions___ApcClusterMetricsDimensions__: properties: field: anyOf: - $ref: >- #/components/schemas/SemiStructuredDimension_ApcClusterMetricsDimensions_ - $ref: '#/components/schemas/ApcClusterMetricsDimensions' title: Field not: type: boolean title: Not default: false values: items: anyOf: - $ref: '#/components/schemas/EqValue' - $ref: '#/components/schemas/DictValue' type: array title: Values operator: type: string const: array_contains title: Operator type: object required: - field - values - operator title: >- ArrayContainsFilter[Union[SemiStructuredDimension[ApcClusterMetricsDimensions], ApcClusterMetricsDimensions]] IsFilter_Union_SemiStructuredDimension_ApcClusterMetricsDimensions___ApcClusterMetricsDimensions__: properties: field: anyOf: - $ref: >- #/components/schemas/SemiStructuredDimension_ApcClusterMetricsDimensions_ - $ref: '#/components/schemas/ApcClusterMetricsDimensions' title: Field not: type: boolean title: Not default: false value: type: 'null' title: Value operator: type: string enum: - is - is not title: Operator type: object required: - field - operator title: >- IsFilter[Union[SemiStructuredDimension[ApcClusterMetricsDimensions], ApcClusterMetricsDimensions]] LikeFilter_Union_SemiStructuredDimension_ApcClusterMetricsDimensions___ApcClusterMetricsDimensions__: properties: field: anyOf: - $ref: >- #/components/schemas/SemiStructuredDimension_ApcClusterMetricsDimensions_ - $ref: '#/components/schemas/ApcClusterMetricsDimensions' title: Field not: type: boolean title: Not default: false value: type: string title: Value operator: type: string enum: - ilike - startswith - array_contains_prefix - array_contains_substring title: Operator type: object required: - field - value - operator title: >- LikeFilter[Union[SemiStructuredDimension[ApcClusterMetricsDimensions], ApcClusterMetricsDimensions]] MultiLikeFilter_Union_SemiStructuredDimension_ApcClusterMetricsDimensions___ApcClusterMetricsDimensions__: properties: field: anyOf: - $ref: >- #/components/schemas/SemiStructuredDimension_ApcClusterMetricsDimensions_ - $ref: '#/components/schemas/ApcClusterMetricsDimensions' title: Field not: type: boolean title: Not default: false values: items: type: string type: array title: Values operator: type: string enum: - ilike - startswith title: Operator type: object required: - field - values - operator title: >- MultiLikeFilter[Union[SemiStructuredDimension[ApcClusterMetricsDimensions], ApcClusterMetricsDimensions]] InRelativeDateRangeFilter_Union_SemiStructuredDimension_ApcClusterMetricsDimensions___ApcClusterMetricsDimensions__: properties: field: anyOf: - $ref: >- #/components/schemas/SemiStructuredDimension_ApcClusterMetricsDimensions_ - $ref: '#/components/schemas/ApcClusterMetricsDimensions' title: Field not: type: boolean title: Not default: false value: type: string title: Value operator: type: string enum: - in range - not in range title: Operator type: object required: - field - value - operator title: >- InRelativeDateRangeFilter[Union[SemiStructuredDimension[ApcClusterMetricsDimensions], ApcClusterMetricsDimensions]] EqValue: anyOf: - type: integer - type: number - type: boolean - type: string - type: string format: date - type: 'null' DictValue: additionalProperties: anyOf: - $ref: '#/components/schemas/EqValue' - items: $ref: '#/components/schemas/EqValue' type: array type: object PivotSort: properties: field: type: string title: Field direction: type: string enum: - asc - desc title: Direction type: object required: - field - direction title: PivotSort responses: BadRequest: description: Bad request content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetail' Unauthorized: description: Unauthorized content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetail' headers: WWW-Authenticate: description: Authentication challenge for the requested resource. required: true schema: type: string Forbidden: description: Forbidden content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetail' NotFound: description: Not found content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetail' MethodNotAllowed: description: Method not allowed content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetail' headers: Allow: description: HTTP methods supported by the requested resource. required: true schema: type: string RequestTimeout: description: Request Timeout content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetail' Conflict: description: Conflict content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetail' ValidationFailed: description: Validation failed content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetail' RateLimited: description: Rate limited content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetail' headers: Retry-After: description: Number of seconds to wait before retrying the request. required: true schema: type: integer minimum: 0 InternalError: description: Internal error content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetail' ServiceUnavailable: description: Service unavailable content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetail' headers: Retry-After: description: Number of seconds to wait before retrying the request. required: true schema: type: integer minimum: 0 securitySchemes: HTTPBearer: type: http description: Organization API key (sl_…). scheme: bearer ````