Altimate AI DATABRICKS API

openapi: 3.1.0
info:
  title: Fast ACCOUNT_COSTS DATABRICKS API
  version: 0.1.0
tags:
- name: DATABRICKS
paths:
  /api/v1/databricks/datapilot/initial-questions:
    get:
      tags:
      - DATABRICKS
      summary: Get AI Studio initial questions for Databricks resources
      description: Get suggested AI Studio questions for Databricks resources.
      operationId: get_databricks_initial_questions_api_v1_databricks_datapilot_initial_questions_get
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: resource_type
        in: query
        required: true
        schema:
          $ref: '#/components/schemas/DatabricksResourceType'
          description: Type of resource (cluster, warehouse, job, query, user)
        description: Type of resource (cluster, warehouse, job, query, user)
      - name: resource_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Optional resource ID for context
          title: Resource Id
        description: Optional resource ID for context
      - name: resource_name
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Optional resource name for context
          title: Resource Name
        description: Optional resource name for context
      - name: workspace_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Optional workspace ID for context
          title: Workspace Id
        description: Optional workspace ID for context
      - name: x-tenant
        in: header
        required: true
        schema:
          type: string
          title: X-Tenant
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/databricks/cost/workspaces:
    get:
      tags:
      - DATABRICKS
      summary: Get available Databricks workspaces
      description: Get list of available Databricks workspaces.
      operationId: get_workspaces_api_v1_databricks_cost_workspaces_get
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - 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/WorkspacesResponse'
        '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/cost/overview:
    get:
      tags:
      - DATABRICKS
      summary: Get Databricks cost overview
      description: 'Get cost overview with summary metrics.


        Returns total DBUs, estimated cost, and period-over-period comparison.'
      operationId: get_cost_overview_api_v1_databricks_cost_overview_get
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: start_date
        in: query
        required: true
        schema:
          type: string
          format: date
          description: Start date for the period
          title: Start Date
        description: Start date for the period
      - name: end_date
        in: query
        required: false
        schema:
          type: string
          format: date
          description: End date for the period
          title: End Date
        description: End date for the period
      - 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/CostOverviewResponse'
        '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/cost/trends:
    get:
      tags:
      - DATABRICKS
      summary: Get Databricks cost trends over time
      description: 'Get cost trends over time.


        Returns time series data with DBU consumption and estimated cost per period.'
      operationId: get_cost_trends_api_v1_databricks_cost_trends_get
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: start_date
        in: query
        required: true
        schema:
          type: string
          format: date
          description: Start date for the period
          title: Start Date
        description: Start date for the period
      - name: end_date
        in: query
        required: false
        schema:
          type: string
          format: date
          description: End date for the period
          title: End Date
        description: End date for the period
      - 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/CostTrendsResponse'
        '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/cost/trends/by-product:
    get:
      tags:
      - DATABRICKS
      summary: Get Databricks cost trends by product over time
      description: 'Get cost trends over time, sliced for a UI category.


        Returns time series data with DBU consumption and estimated cost per

        period, with each row labelled by the category''s chosen segment. The

        ``products`` array in the response is the canonical legend for the

        category (in display order, including segments with no data) so the FE

        legend stays stable across date ranges.'
      operationId: get_cost_trends_by_product_api_v1_databricks_cost_trends_by_product_get
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: start_date
        in: query
        required: true
        schema:
          type: string
          format: date
          description: Start date for the period
          title: Start Date
        description: Start date for the period
      - name: end_date
        in: query
        required: false
        schema:
          type: string
          format: date
          description: End date for the period
          title: End Date
        description: End date for the period
      - 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: category
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/CategoryName'
          description: Which UI category the chart is for. Drives both the product filter and the per-row segment label. ``total`` returns the 5 spec-group stack (Clusters / SQL Warehouse / AI/ML / Lakehouse / Platform). ``sql_warehouse`` returns Classic / Pro / Serverless. Other values return the products in that spec group.
          default: total
        description: Which UI category the chart is for. Drives both the product filter and the per-row segment label. ``total`` returns the 5 spec-group stack (Clusters / SQL Warehouse / AI/ML / Lakehouse / Platform). ``sql_warehouse`` returns Classic / Pro / Serverless. Other values return the products in that spec group.
      - 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/ProductTrendsResponse'
        '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/cost/trends/by-product/estimate:
    get:
      tags:
      - DATABRICKS
      summary: Get Databricks cost trends by product with projections
      description: 'Get cost trends by product with future projections.


        Returns monthly cost data by product (JOBS, SQL, ALL_PURPOSE, etc.) with

        projections to end of period. Used for Future State visualization showing

        product-level historical + projected costs.'
      operationId: get_cost_trends_by_product_estimate_api_v1_databricks_cost_trends_by_product_estimate_get
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: start_date
        in: query
        required: true
        schema:
          type: string
          format: date
          description: Start date (typically start of year)
          title: Start Date
        description: Start date (typically start of year)
      - name: end_date
        in: query
        required: true
        schema:
          type: string
          format: date
          description: End date (typically end of year)
          title: End Date
        description: End date (typically end of year)
      - 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/ProductEstimateTrendsResponse'
        '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/cost/breakdown/sku:
    get:
      tags:
      - DATABRICKS
      summary: Get cost breakdown by SKU
      description: 'Get cost breakdown by SKU.


        Returns DBU consumption and cost grouped by Databricks SKU type.'
      operationId: get_cost_breakdown_by_sku_api_v1_databricks_cost_breakdown_sku_get
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: start_date
        in: query
        required: true
        schema:
          type: string
          format: date
          description: Start date for the period
          title: Start Date
        description: Start date for the period
      - name: end_date
        in: query
        required: false
        schema:
          type: string
          format: date
          description: End date for the period
          title: End Date
        description: End date for the period
      - 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: sortAttribute
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: 'Sort column: name, total_dbus, or total_cost. Default total_cost.'
          title: Sortattribute
        description: 'Sort column: name, total_dbus, or total_cost. Default total_cost.'
      - name: sortOrder
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: 'Sort direction: ''asc'' or ''desc''. Default ''desc''.'
          title: Sortorder
        description: 'Sort direction: ''asc'' or ''desc''. Default ''desc''.'
      - name: sku_names
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: Filter to specific SKU names (multi-value)
          title: Sku Names
        description: Filter to specific SKU names (multi-value)
      - 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/app__schemas__databricks__cost__CostBreakdownResponse'
        '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/cost/breakdown/workspace:
    get:
      tags:
      - DATABRICKS
      summary: Get cost breakdown by workspace
      description: 'Get cost breakdown by workspace.


        Returns DBU consumption and cost grouped by Databricks workspace.'
      operationId: get_cost_breakdown_by_workspace_api_v1_databricks_cost_breakdown_workspace_get
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: start_date
        in: query
        required: true
        schema:
          type: string
          format: date
          description: Start date for the period
          title: Start Date
        description: Start date for the period
      - name: end_date
        in: query
        required: false
        schema:
          type: string
          format: date
          description: End date for the period
          title: End Date
        description: End date for the period
      - 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/app__schemas__databricks__cost__CostBreakdownResponse'
        '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/cost/breakdown/product:
    get:
      tags:
      - DATABRICKS
      summary: Get cost breakdown by product
      description: 'Get cost breakdown by product.


        Returns DBU consumption and cost grouped by Databricks product type.'
      operationId: get_cost_breakdown_by_product_api_v1_databricks_cost_breakdown_product_get
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: start_date
        in: query
        required: true
        schema:
          type: string
          format: date
          description: Start date for the period
          title: Start Date
        description: Start date for the period
      - name: end_date
        in: query
        required: false
        schema:
          type: string
          format: date
          description: End date for the period
          title: End Date
        description: End date for the period
      - 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: sortAttribute
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: 'Sort column: name, total_dbus, or total_cost. Default total_cost.'
          title: Sortattribute
        description: 'Sort column: name, total_dbus, or total_cost. Default total_cost.'
      - name: sortOrder
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: 'Sort direction: ''asc'' or ''desc''. Default ''desc''.'
          title: Sortorder
        description: 'Sort direction: ''asc'' or ''desc''. Default ''desc''.'
      - name: products
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: Filter to specific billing_origin_product values
          title: Products
        description: Filter to specific billing_origin_product values
      - 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/app__schemas__databricks__cost__CostBreakdownResponse'
        '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/cost/comparison:
    get:
      tags:
      - DATABRICKS
      summary: Get cost comparison between periods
      description: 'Get cost comparison between current and previous period.


        Automatically calculates the previous period based on the duration of the current period.'
      operationId: get_cost_comparison_api_v1_databricks_cost_comparison_get
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: start_date
        in: query
        required: true
        schema:
          type: string
          format: date
          description: Start date for the current period
          title: Start Date
        description: Start date for the current period
      - name: end_date
        in: query
        required: false
        schema:
          type: string
          format: date
          description: End date for the current period
          title: End Date
        description: End date for the current period
      - 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/CostComparisonResponse'
        '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/cost/total:
    get:
      tags:
      - DATABRICKS
      summary: Get total cost with category breakdown
      description: 'Get total cost with category breakdown.


        Returns total cost and DBUs with breakdown by cost category

        (Compute, SQL, AI/ML, Data Platform, Infrastructure).'
      operationId: get_cost_total_api_v1_databricks_cost_total_get
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: start_date
        in: query
        required: true
        schema:
          type: string
          format: date
          description: Start date for the period
          title: Start Date
        description: Start date for the period
      - name: end_date
        in: query
        required: false
        schema:
          type: string
          format: date
          description: End date for the period
          title: End Date
        description: End date for the period
      - 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/CostTotalResponse'
        '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/cost/overall/estimate:
    get:
      tags:
      - DATABRICKS
      summary: Get cost trends with future projections
      description: 'Get cost trends with future projections, segmented for a UI category.


        Returns monthly cost data with projections to end of period — each graph

        point carries the per-segment breakdown for the requested ``category``.

        Used for Future State visualization showing historical + projected costs.'
      operationId: get_cost_trends_estimate_api_v1_databricks_cost_overall_estimate_get
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: start_date
        in: query
        required: true
        schema:
          type: string
          format: date
          description: Start date (typically start of year)
          title: Start Date
        description: Start date (typically start of year)
      - name: end_date
        in: query
        required: true
        schema:
          type: string
          format: date
          description: End date (typically end of year)
          title: End Date
        description: End date (typically end of year)
      - 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: category
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/CategoryName'
          description: Which UI category to segment the projection by. ``total`` → the 6 spec groups; ``sql_warehouse`` → Classic / Pro / Serverless; other values → the products of that spec group. Mirrors ``/cost/trends/by-product``.
          default: total
        description: Which UI category to segment the projection by. ``total`` → the 6 spec groups; ``sql_warehouse`` → Classic / Pro / Serverless; other values → the products of that spec group. Mirrors ``/cost/trends/by-product``.
      - 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/CostEstimateTrendsResponse'
        '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/cost/total/estimate:
    get:
      tags:
      - DATABRICKS
      summary: Get total estimated cost for the year
      description: 'Get total estimated cost for the period (actual + projected).


        Returns the grand total plus a per-segment breakdown for the requested

        ``category``. Used for Future State total cost display.'
      operationId: get_cost_total_estimate_api_v1_databricks_cost_total_estimate_get
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: start_date
        in: query
        required: true
        schema:
          type: string
          format: date
          description: Start date (typically start of year)
          title: Start Date
        description: Start date (typically start of year)
      - name: end_date
        in: query
        required: true
        schema:
          type: string
          format: date
          description: End date (typically end of year)
          title: End Date
        description: End date (typically end of year)
      - 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: category
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/CategoryName'
          description: Which UI category to segment the estimate by. See ``/cost/overall/estimate`` for the segmentation rules.
          default: total
        description: Which UI category to segment the estimate by. See ``/cost/overall/estimate`` for the segmentation rules.
      - 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/CostTotalEstimateResponse'
        '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/cost/compute-efficiency:
    get:
      tags:
      - DATABRICKS
      summary: Get compute efficiency breakdown
      description: 'Get compute efficiency breakdown.


        Returns efficiency metrics including:

        - Jobs vs All-Purpose ratio (healthy = >70% jobs)

        - Serverless vs Provisioned breakdown

        - Photon vs Standard engine usage'
      operationId: get_compute_efficiency_api_v1_databricks_cost_compute_efficiency_get
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: start_date
        in: query
        required: true
        schema:
          type: string
          format: date
          description: Start date for the period
          title: Start Date
        description: Start date for the period
      - name: end_date
        in: query
        required: false
        schema:
          type: string
          format: date
          description: End date for the period
          title: End Date
        description: End date for the period
      - 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
   

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