Altimate AI Databricks Queries API

openapi: 3.1.0
info:
  title: Fast ACCOUNT_COSTS Databricks Queries API
  version: 0.1.0
tags:
- name: Databricks Queries
paths:
  /api/v1/databricks/queries/filters:
    get:
      tags:
      - Databricks Queries
      summary: Get filter options for queries
      description: Get distinct filter values for query filtering.
      operationId: get_query_filters_api_v1_databricks_queries_filters_get
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: prefix
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Search prefix for name filters
          title: Prefix
        description: Search prefix for name filters
      - name: workspace_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Workspace ID to filter by
          title: Workspace Id
        description: Workspace ID to filter by
      - name: start_date
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Start date for filtering (YYYY-MM-DD)
          title: Start Date
        description: Start date for filtering (YYYY-MM-DD)
      - name: end_date
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: End date for filtering (YYYY-MM-DD)
          title: End Date
        description: End date for filtering (YYYY-MM-DD)
      - name: navigationSource
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Navigationsource
      - name: x-tenant
        in: header
        required: true
        schema:
          type: string
          title: X-Tenant
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryFilterOptions'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/databricks/queries/filters/users:
    get:
      tags:
      - Databricks Queries
      summary: Search query-history user names by prefix
      description: 'Server-side search for query-history user names — a dedicated single

        list so the typed prefix only scans user names, never the other

        ``/queries/filters`` lists.'
      operationId: search_query_users_api_v1_databricks_queries_filters_users_get
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: prefix
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Substring to match user names against
          title: Prefix
        description: Substring to match user names against
      - name: workspace_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Filter by workspace ID
          title: Workspace Id
        description: Filter by workspace ID
      - name: start_date
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date
          - type: 'null'
          description: Start date
          title: Start Date
        description: Start date
      - name: end_date
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date
          - type: 'null'
          description: End date
          title: End Date
        description: End date
      - name: page
        in: query
        required: false
        schema:
          type: integer
          minimum: 1
          description: Page number (1-indexed)
          default: 1
          title: Page
        description: Page number (1-indexed)
      - name: size
        in: query
        required: false
        schema:
          type: integer
          maximum: 100
          minimum: 1
          description: Items per page
          default: 20
          title: Size
        description: Items per page
      - name: navigationSource
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Navigationsource
      - name: x-tenant
        in: header
        required: true
        schema:
          type: string
          title: X-Tenant
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryUserNamesResponse'
        '403':
          description: Not authorized
        '404':
          description: No ClickHouse database configured
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/databricks/queries/filters/computes:
    get:
      tags:
      - Databricks Queries
      summary: Search the unified compute list by prefix
      description: 'Server-side search for the unified compute list (warehouse + cluster +

        pipeline) — a dedicated single list so the typed prefix only scans

        computes, never the other ``/queries/filters`` lists.'
      operationId: search_query_computes_api_v1_databricks_queries_filters_computes_get
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: prefix
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Substring to match compute display labels against
          title: Prefix
        description: Substring to match compute display labels against
      - name: workspace_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Filter by workspace ID
          title: Workspace Id
        description: Filter by workspace ID
      - name: start_date
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date
          - type: 'null'
          description: Start date
          title: Start Date
        description: Start date
      - name: end_date
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date
          - type: 'null'
          description: End date
          title: End Date
        description: End date
      - name: page
        in: query
        required: false
        schema:
          type: integer
          minimum: 1
          description: Page number (1-indexed)
          default: 1
          title: Page
        description: Page number (1-indexed)
      - name: size
        in: query
        required: false
        schema:
          type: integer
          maximum: 100
          minimum: 1
          description: Items per page
          default: 20
          title: Size
        description: Items per page
      - name: navigationSource
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Navigationsource
      - name: x-tenant
        in: header
        required: true
        schema:
          type: string
          title: X-Tenant
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryComputesResponse'
        '403':
          description: Not authorized
        '404':
          description: No ClickHouse database configured
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/databricks/queries/filters/workspaces:
    get:
      tags:
      - Databricks Queries
      summary: Search query-history workspaces by name prefix
      description: 'Server-side search for query-history workspaces — a dedicated single

        list so the typed prefix only scans workspaces, never the other

        ``/queries/filters`` lists. A tenant can have thousands of workspaces.'
      operationId: search_query_workspaces_api_v1_databricks_queries_filters_workspaces_get
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: prefix
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Substring to match workspace names against
          title: Prefix
        description: Substring to match workspace names against
      - name: start_date
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date
          - type: 'null'
          description: Start date
          title: Start Date
        description: Start date
      - name: end_date
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date
          - type: 'null'
          description: End date
          title: End Date
        description: End date
      - name: page
        in: query
        required: false
        schema:
          type: integer
          minimum: 1
          description: Page number (1-indexed)
          default: 1
          title: Page
        description: Page number (1-indexed)
      - name: size
        in: query
        required: false
        schema:
          type: integer
          maximum: 100
          minimum: 1
          description: Items per page
          default: 20
          title: Size
        description: Items per page
      - name: navigationSource
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Navigationsource
      - name: x-tenant
        in: header
        required: true
        schema:
          type: string
          title: X-Tenant
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryWorkspacesResponse'
        '403':
          description: Not authorized
        '404':
          description: No ClickHouse database configured
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/databricks/queries/filters/statement-ids:
    get:
      tags:
      - Databricks Queries
      summary: Search statement IDs for the Query ID filter dropdown
      description: 'Server-side search for statement IDs — backs the Query ID filter dropdown.


        Matches statement IDs by substring so the dropdown never loads the full

        ID list; results are paginated.'
      operationId: search_query_statement_ids_api_v1_databricks_queries_filters_statement_ids_get
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: start_date
        in: query
        required: true
        schema:
          type: string
          format: date
          description: Start date
          title: Start Date
        description: Start date
      - name: end_date
        in: query
        required: false
        schema:
          type: string
          format: date
          description: End date
          title: End Date
        description: End date
      - name: workspace_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Filter by workspace ID
          title: Workspace Id
        description: Filter by workspace ID
      - name: prefix
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Substring to match statement IDs against. Searches kick in once the typed text reaches 2 characters; shorter inputs return an empty list without scanning ClickHouse so the dropdown's open-with-empty-prefix probe is free.
          title: Prefix
        description: Substring to match statement IDs against. Searches kick in once the typed text reaches 2 characters; shorter inputs return an empty list without scanning ClickHouse so the dropdown's open-with-empty-prefix probe is free.
      - name: page
        in: query
        required: false
        schema:
          type: integer
          minimum: 1
          description: Page number (1-indexed)
          default: 1
          title: Page
        description: Page number (1-indexed)
      - name: page_size
        in: query
        required: false
        schema:
          type: integer
          maximum: 100
          minimum: 1
          description: Number of IDs per page
          default: 25
          title: Page Size
        description: Number of IDs per page
      - name: navigationSource
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Navigationsource
      - name: x-tenant
        in: header
        required: true
        schema:
          type: string
          title: X-Tenant
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryStatementIdsResponse'
        '403':
          description: Not authorized
        '404':
          description: No ClickHouse database configured
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/databricks/queries/summary:
    get:
      tags:
      - Databricks Queries
      summary: Get query summary metrics
      description: 'Get summary metrics for queries.


        Accepts the same filter set as ``GET /queries/unified`` so the summary

        cards reflect the exact rows the queries table renders for a given

        filter selection.'
      operationId: get_query_summary_api_v1_databricks_queries_summary_get
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: start_date
        in: query
        required: true
        schema:
          type: string
          format: date
          description: Start date
          title: Start Date
        description: Start date
      - name: end_date
        in: query
        required: false
        schema:
          type: string
          format: date
          description: End date
          title: End Date
        description: End date
      - name: workspace_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Filter by single workspace ID (legacy URL pre-selection)
          title: Workspace Id
        description: Filter by single workspace ID (legacy URL pre-selection)
      - name: workspace_ids
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: Filter by one or more workspace IDs (column multi-select)
          title: Workspace Ids
        description: Filter by one or more workspace IDs (column multi-select)
      - name: warehouse_id
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: Filter by one or more warehouse IDs (legacy column multi-select). Prefer ``compute_id`` for new FE bindings — it covers warehouse + cluster + pipeline in one parameter. Entries here are merged with any ``compute_id`` warehouse selections before the BE applies the filter.
          title: Warehouse Id
        description: Filter by one or more warehouse IDs (legacy column multi-select). Prefer ``compute_id`` for new FE bindings — it covers warehouse + cluster + pipeline in one parameter. Entries here are merged with any ``compute_id`` warehouse selections before the BE applies the filter.
      - name: compute_id
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: 'Unified Compute filter: one or more ``{kind}:{id}`` selections from the dropdown, where ``kind`` is ``warehouse``, ``cluster``, or ``pipeline``. A mixed selection is ORed (rows of any selected kind match). Entries with an unknown ``kind`` or empty id are silently skipped so this stays forward-compatible if the FE adopts a new kind ahead of the BE.'
          title: Compute Id
        description: 'Unified Compute filter: one or more ``{kind}:{id}`` selections from the dropdown, where ``kind`` is ``warehouse``, ``cluster``, or ``pipeline``. A mixed selection is ORed (rows of any selected kind match). Entries with an unknown ``kind`` or empty id are silently skipped so this stays forward-compatible if the FE adopts a new kind ahead of the BE.'
      - name: insights
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: Filter by insight tags (slow_query, disk_spill, full_table_scan, failed)
          title: Insights
        description: Filter by insight tags (slow_query, disk_spill, full_table_scan, failed)
      - name: statement_type
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Filter by statement type
          title: Statement Type
        description: Filter by statement type
      - name: user_name
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: Filter by one or more user names. Single-value calls (e.g. the User-list drilldown URL ``?user_name=alice``) continue to work — FastAPI parses the single value as a one-element list and the BE applies the matching IN-clause filter. Multi-select dropdowns send ``?user_name=alice&user_name=bob``.
          title: User Name
        description: Filter by one or more user names. Single-value calls (e.g. the User-list drilldown URL ``?user_name=alice``) continue to work — FastAPI parses the single value as a one-element list and the BE applies the matching IN-clause filter. Multi-select dropdowns send ``?user_name=alice&user_name=bob``.
      - name: statement_ids
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: Filter by one or more exact query (statement) IDs
          title: Statement Ids
        description: Filter by one or more exact query (statement) IDs
      - name: navigationSource
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Navigationsource
      - name: x-tenant
        in: header
        required: true
        schema:
          type: string
          title: X-Tenant
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QuerySummaryResponse'
        '403':
          description: Not authorized
        '404':
          description: No ClickHouse database configured
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/databricks/queries/trends:
    get:
      tags:
      - Databricks Queries
      summary: Get query trends
      description: Get query trends over time.
      operationId: get_query_trends_api_v1_databricks_queries_trends_get
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: start_date
        in: query
        required: true
        schema:
          type: string
          format: date
          description: Start date
          title: Start Date
        description: Start date
      - name: end_date
        in: query
        required: false
        schema:
          type: string
          format: date
          description: End date
          title: End Date
        description: End date
      - name: granularity
        in: query
        required: false
        schema:
          type: string
          description: 'Time granularity: ''day'', ''week'', or ''month'''
          default: day
          title: Granularity
        description: 'Time granularity: ''day'', ''week'', or ''month'''
      - name: workspace_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Filter by workspace ID
          title: Workspace Id
        description: Filter by workspace ID
      - name: navigationSource
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Navigationsource
      - name: x-tenant
        in: header
        required: true
        schema:
          type: string
          title: X-Tenant
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryTrendsResponse'
        '403':
          description: Not authorized
        '404':
          description: No ClickHouse database configured
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/databricks/queries/trends/cost-by-user:
    get:
      tags:
      - Databricks Queries
      summary: Get query cost trends by user
      description: Get query cost trends over time broken down by user.
      operationId: get_query_cost_trends_by_user_api_v1_databricks_queries_trends_cost_by_user_get
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: start_date
        in: query
        required: true
        schema:
          type: string
          format: date
          description: Start date
          title: Start Date
        description: Start date
      - name: end_date
        in: query
        required: false
        schema:
          type: string
          format: date
          description: End date
          title: End Date
        description: End date
      - name: granularity
        in: query
        required: false
        schema:
          type: string
          description: 'Time granularity: ''day'', ''week'', or ''month'''
          default: day
          title: Granularity
        description: 'Time granularity: ''day'', ''week'', or ''month'''
      - name: workspace_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Filter by workspace ID
          title: Workspace Id
        description: Filter by workspace ID
      - name: top_n
        in: query
        required: false
        schema:
          type: integer
          maximum: 10
          minimum: 1
          description: Number of top users to show
          default: 5
          title: Top N
        description: Number of top users to show
      - name: navigationSource
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Navigationsource
      - name: x-tenant
        in: header
        required: true
        schema:
          type: string
          title: X-Tenant
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryCostTrendsByUserResponse'
        '403':
          description: Not authorized
        '404':
          description: No ClickHouse database configured
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/databricks/queries:
    get:
      tags:
      - Databricks Queries
      summary: Get queries
      description: Get queries with filters.
      operationId: get_queries_api_v1_databricks_queries_get
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: start_date
        in: query
        required: true
        schema:
          type: string
          format: date
          description: Start date
          title: Start Date
        description: Start date
      - name: end_date
        in: query
        required: false
        schema:
          type: string
          format: date
          description: End date
          title: End Date
        description: End date
      - name: workspace_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Filter by workspace ID
          title: Workspace Id
        description: Filter by workspace ID
      - name: statement_type
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Filter by statement type
          title: Statement Type
        description: Filter by statement type
      - name: execution_status
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Filter by execution status (FINISHED, FAILED)
          title: Execution Status
        description: Filter by execution status (FINISHED, FAILED)
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          description: Maximum number of queries
          default: 100
          title: Limit
        description: Maximum number of queries
      - name: navigationSource
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Navigationsource
      - name: x-tenant
        in: header
        required: true
        schema:
          type: string
          title: X-Tenant
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueriesResponse'
        '403':
          description: Not authorized
        '404':
          description: No ClickHouse database configured
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/databricks/queries/slow:
    get:
      tags:
      - Databricks Queries
      summary: Get slow queries
      description: Get slow queries (queries exceeding duration threshold).
      operationId: get_slow_queries_api_v1_databricks_queries_slow_get
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: start_date
        in: query
        required: true
        schema:
          type: string
          format: date
          description: Start date
          title: Start Date
        description: Start date
      - name: end_date
        in: query
        required: false
        schema:
          type: string
          format: date
          description: End date
          title: End Date
        description: End date
      - name: min_duration_ms
        in: query
        required: false
        schema:
          type: integer
          description: Minimum duration in milliseconds
          default: 60000
          title: Min Duration Ms
        description: Minimum duration in milliseconds
      - name: workspace_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Filter by workspace ID
          title: Workspace Id
        description: Filter by workspace ID
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          description: Maximum number of queries
          default: 100
          title: Limit
        description: Maximum number of queries
      - name: navigationSource
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Navigationsource
      - name: x-tenant
        in: header
        required: true
        schema:
          type: string
          title: X-Tenant
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SlowQueriesResponse'
        '403':
          description: Not authorized
        '404':
          description: No ClickHouse database configured
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/databricks/queries/spills:
    get:
      tags:
      - Databricks Queries
      summary: Get queries with memory spills
      description: Get queries with memory spills.
      operationId: get_spill_queries_api_v1_databricks_queries_spills_get
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: start_date
        in: query
        required: true
        schema:
          type: string
          format: date
          description: Start date
          title: Start Date
        description: Start date
      - name: end_date
        in: query
        required: false
        schema:
          type: string
          format: date
          description: End date
          title: End Date
        description: End date
      - name: min_spill_bytes
        in: query
        required: false
        schema:
          type: integer
          description: Minimum spill bytes (default 1MB)
          default: 1048576
          title: Min Spill Bytes
        description: Minimum spill bytes (default 1MB)
      - name: workspace_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Filter by workspace ID
          title: Workspace Id
        description: Filter by workspace ID
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          description: Maximum number of queries
          default: 100
          title: Limit
        description: Maximum number of queries
      - name: navigationSource
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Navigationsource
      - name: x-tenant
        in: header
        required: true
        schema:
          type: string
          title: X-Tenant
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SpillQueriesResponse'
        '403':
          description: Not authorized
        '404':
          description: No Cli

# --- truncated at 32 KB (77 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/altimate-ai/refs/heads/main/openapi/altimate-ai-databricks-queries-api-openapi.yml