Altimate AI Databricks Jobs API
The Databricks Jobs API from Altimate AI — 29 operation(s) for databricks jobs.
The Databricks Jobs API from Altimate AI — 29 operation(s) for databricks jobs.
openapi: 3.1.0
info:
title: Fast ACCOUNT_COSTS Databricks Jobs API
version: 0.1.0
tags:
- name: Databricks Jobs
paths:
/api/v1/databricks/jobs/filters:
get:
tags:
- Databricks Jobs
summary: Get filter options for jobs
description: Get distinct filter values for job filtering.
operationId: get_job_filters_api_v1_databricks_jobs_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: 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/JobFilterOptions'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/databricks/jobs/filters/job_names:
get:
tags:
- Databricks Jobs
summary: Get paginated distinct job names for filtering
description: Get a paginated list of distinct job names for the job-name filter dropdown.
operationId: get_job_name_filters_api_v1_databricks_jobs_filters_job_names_get
security:
- HTTPBearer: []
- HTTPBearer: []
parameters:
- name: prefix
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: Search substring for job names (case-insensitive)
title: Prefix
description: Search substring for job names (case-insensitive)
- 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: 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/PaginatedJobNamesResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/databricks/jobs/filters/workspaces:
get:
tags:
- Databricks Jobs
summary: Get paginated distinct job workspaces for filtering
description: Get a paginated list of distinct job workspaces for the workspace filter dropdown.
operationId: get_job_workspace_filters_api_v1_databricks_jobs_filters_workspaces_get
security:
- HTTPBearer: []
- HTTPBearer: []
parameters:
- name: prefix
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: Search substring for workspace names (case-insensitive)
title: Prefix
description: Search substring for workspace names (case-insensitive)
- 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: 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/PaginatedJobNamesResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/databricks/jobs/filters/creators:
get:
tags:
- Databricks Jobs
summary: Get paginated distinct job creators for filtering
description: Get a paginated list of distinct job creators with display names.
operationId: get_job_creator_filters_api_v1_databricks_jobs_filters_creators_get
security:
- HTTPBearer: []
- HTTPBearer: []
parameters:
- name: prefix
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: Search substring against creator id or display name (case-insensitive)
title: Prefix
description: Search substring against creator id or display name (case-insensitive)
- 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: 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/PaginatedJobCreatorsResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/databricks/jobs:
get:
tags:
- Databricks Jobs
summary: Get all Databricks jobs
description: Get list of all jobs with run statistics.
operationId: get_jobs_api_v1_databricks_jobs_get
security:
- HTTPBearer: []
- HTTPBearer: []
parameters:
- 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: true
schema:
type: string
format: date
description: Start date for run statistics
title: Start Date
description: Start date for run statistics
- name: end_date
in: query
required: false
schema:
type: string
format: date
description: End date for run statistics
title: End Date
description: End date for run statistics
- 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: Items per page
default: 20
title: Page Size
description: Items per page
- name: sortAttribute
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: 'Sort column name. Valid columns: job_name, workspace_name, total_runs, successful_runs, failed_runs, success_rate, avg_duration_seconds, last_run_time, total_dbus, total_cost, annualized_total_cost, auto_tune_savings.'
title: Sortattribute
description: 'Sort column name. Valid columns: job_name, workspace_name, total_runs, successful_runs, failed_runs, success_rate, avg_duration_seconds, last_run_time, total_dbus, total_cost, annualized_total_cost, auto_tune_savings.'
- name: sortOrder
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: 'Sort direction: ''asc'' or ''desc'''
title: Sortorder
description: 'Sort direction: ''asc'' or ''desc'''
- name: job_names
in: query
required: false
schema:
anyOf:
- type: array
items:
type: string
- type: 'null'
description: Filter by job names
title: Job Names
description: Filter by job names
- name: creators
in: query
required: false
schema:
anyOf:
- type: array
items:
type: string
- type: 'null'
description: Filter by creator user names
title: Creators
description: Filter by creator user names
- name: workspaces
in: query
required: false
schema:
anyOf:
- type: array
items:
type: string
- type: 'null'
description: Filter by workspace display names
title: Workspaces
description: Filter by workspace display names
- name: auto_tune_enabled
in: query
required: false
schema:
anyOf:
- type: boolean
- type: 'null'
description: 'Filter by Auto Tune state: true for On, false for Off'
title: Auto Tune Enabled
description: 'Filter by Auto Tune state: true for On, false for Off'
- 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/JobsResponse'
'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/jobs/summary:
get:
tags:
- Databricks Jobs
summary: Get aggregate cost summary for the Jobs list
description: 'Aggregate cost summary feeding the Jobs page hero cards.
Returns Total Cost, Total DBU Cost (equal to Total Cost — DBU is the
only cost component), Total Cloud Cost (``null`` — infrastructure cost
is not ingested), and Total Realized Savings (summed from the
``dbx_jobs_cost_savings`` cost mart).'
operationId: get_jobs_summary_api_v1_databricks_jobs_summary_get
security:
- HTTPBearer: []
- HTTPBearer: []
parameters:
- name: start_date
in: query
required: true
schema:
type: string
format: date
description: Start date for the cost window
title: Start Date
description: Start date for the cost window
- name: end_date
in: query
required: false
schema:
type: string
format: date
description: End date for the cost window
title: End Date
description: End date for the cost window
- 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/JobsSummaryResponse'
'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/jobs/failing:
get:
tags:
- Databricks Jobs
summary: Get jobs with high failure rates
description: Get jobs with high failure rates.
operationId: get_failing_jobs_api_v1_databricks_jobs_failing_get
security:
- HTTPBearer: []
- HTTPBearer: []
parameters:
- name: min_failure_rate
in: query
required: false
schema:
type: number
description: Minimum failure rate percentage
default: 20.0
title: Min Failure Rate
description: Minimum failure rate percentage
- name: start_date
in: query
required: true
schema:
type: string
format: date
description: Start date for statistics
title: Start Date
description: Start date for statistics
- name: end_date
in: query
required: false
schema:
type: string
format: date
description: End date for statistics
title: End Date
description: End date for statistics
- 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/FailingJobsResponse'
'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/jobs/recent-failures:
get:
tags:
- Databricks Jobs
summary: Get recent job failures
description: Get recent job failures.
operationId: get_recent_failures_api_v1_databricks_jobs_recent_failures_get
security:
- HTTPBearer: []
- HTTPBearer: []
parameters:
- name: hours
in: query
required: false
schema:
type: integer
maximum: 720
exclusiveMinimum: 0
description: Hours to look back (1-720).
default: 24
title: Hours
description: Hours to look back (1-720).
- 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/RecentFailuresResponse'
'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/jobs/trends:
get:
tags:
- Databricks Jobs
summary: Get job run trends
description: Get job run trends over time.
operationId: get_job_run_trends_api_v1_databricks_jobs_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/JobRunTrendsResponse'
'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/jobs/trends/cost:
get:
tags:
- Databricks Jobs
summary: Get job cost trends by job
description: 'Get job cost trends over time broken down by job.
Returns every job with billing activity; top-N selection and the
"Others" bucket are applied client-side.'
operationId: get_job_cost_trends_api_v1_databricks_jobs_trends_cost_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/JobCostTrendsResponse'
'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/jobs/{job_id}:
get:
tags:
- Databricks Jobs
summary: Get job details
description: Get detailed information for a specific job.
operationId: get_job_detail_api_v1_databricks_jobs__job_id__get
security:
- HTTPBearer: []
- HTTPBearer: []
parameters:
- name: job_id
in: path
required: true
schema:
type: string
title: Job 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/JobDetail'
'403':
description: Not authorized
'404':
description: Job not found
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/databricks/jobs/{job_id}/runs:
get:
tags:
- Databricks Jobs
summary: Get job runs
description: Get runs for a specific job.
operationId: get_job_runs_api_v1_databricks_jobs__job_id__runs_get
security:
- HTTPBearer: []
- HTTPBearer: []
parameters:
- name: job_id
in: path
required: true
schema:
type: string
title: Job Id
- 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: result_state
in: query
required: false
schema:
anyOf:
- type: array
items:
type: string
- type: 'null'
description: 'Filter by result state. Repeat the query param to pass multiple values (e.g. ?result_state=FAILED&result_state=TIMED_OUT). Valid values: SUCCEEDED, FAILED, SKIPPED, CANCELLED, TIMED_OUT, ERROR, BLOCKED.'
title: Result State
description: 'Filter by result state. Repeat the query param to pass multiple values (e.g. ?result_state=FAILED&result_state=TIMED_OUT). Valid values: SUCCEEDED, FAILED, SKIPPED, CANCELLED, TIMED_OUT, ERROR, BLOCKED.'
- name: run_ids
in: query
required: false
schema:
anyOf:
- type: array
items:
type: string
- type: 'null'
description: Filter by specific run IDs
title: Run Ids
description: Filter by specific run IDs
- name: trigger_types
in: query
required: false
schema:
anyOf:
- type: array
items:
type: string
- type: 'null'
description: Filter by trigger types
title: Trigger Types
description: Filter by trigger types
- name: sortAttribute
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: 'Sort column name. Valid columns: run_id, start_time, duration_seconds, trigger_type, result_state, cost_cents.'
title: Sortattribute
description: 'Sort column name. Valid columns: run_id, start_time, duration_seconds, trigger_type, result_state, cost_cents.'
- name: sortOrder
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: 'Sort direction: ''asc'' or ''desc'''
title: Sortorder
description: 'Sort direction: ''asc'' or ''desc'''
- 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: Items per page
default: 20
title: Page 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/JobRunsResponse'
'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/jobs/{job_id}/stats:
get:
tags:
- Databricks Jobs
summary: Get job run statistics
description: Get run statistics for a specific job.
operationId: get_job_stats_api_v1_databricks_jobs__job_id__stats_get
security:
- HTTPBearer: []
- HTTPBearer: []
parameters:
- name: job_id
in: path
required: true
schema:
type: string
title: Job Id
- 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: 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/JobStatsResponse'
'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/jobs/{job_id}/trends:
get:
tags:
- Databricks Jobs
summary: Get job run trends over time
description: Get run trends over time for a specific job.
operationId: get_single_job_run_trends_api_v1_databricks_jobs__job_id__trends_get
security:
- HTTPBearer: []
- HTTPBearer: []
parameters:
- name: job_id
in: path
required: true
schema:
type: string
title: Job Id
- 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: navigationSource
in: query
required: false
schema:
anyOf:
- type:
# --- truncated at 32 KB (138 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/altimate-ai/refs/heads/main/openapi/altimate-ai-databricks-jobs-api-openapi.yml