Overview
This section provides information about APIs associated with Overview.
Insights Summary
Insights Savings Daily Trend
Realized Savings Summary
TopX Summary
TopX Data
Insights Savings (optimize tab)
Request
GET /api/v1.5/insights/summaryUse this API to retrieve summarized cost, savings, and usage KPIs for a selected time window in a Databricks workspace.
Query parameters
Name | Type | Example Value | Description |
|---|---|---|---|
endTime | string (ISO 8601 datetime) | 2025-11-02T23 :59:59.999Z | End timestamp for the insights summary period in ISO 8601 format. |
startTime | string (ISO 8601 datetime) | 2025-10-04T00 :00:00.000Z | Start timestamp for the insights summary period in ISO 8601 format. |
selectedValue | string | 30_d | Selected duration or time window, such as 7_d, 30_d, or 90_d. |
Examples
curl -X GET \ -H "Authorization: JWT <token>" \ -H "Content-Type: application/json" \ -H "Accept: application/json" \ "https://yourdomain.com/api/v1.5/insights/summary?endTime=2 025-11-02T23:59:59.999Z&startTime=2025-10-04T00:00:00.000Z& selectedValue=30_d"
{
"status": "success",
"summary": [
{
"key": "cost",
"name": "Cost",
"annualized": {
"name": "Annualized",
"cost": 1353.3
},
"total": {
"name": "Total",
"cost": 111.2
},
"entities": [ {
"name": "All-Purpose compute",
"cost": 62.42
},
{
"name": "Job compute",
"cost": 48.78
}
]
},
{
"key": "untappedSavings",
"name": "Untapped savings",
"annualized": {
"name": "Annualized",
"min": 185.45,
"max": 204.97
},
"total": {
"name": "Total",
"min": 15.24,
"max": 16.84
},
"savingsPercentage": {
"min": 13.71,
"max": 15.14
},
"entities": [ {
"key": "allPurposeCompute",
"name": "All-Purpose compute",
"savings": 5.28
},
{
"key": "jobCompute",
"name": "Job compute",
"savings": 10.76
}
]
},
{
"key": "realizedSavings",
"name": "Realized savings",
"annualized": {
"name": "Annualized",
"min": 5.35,
"max": 5.84
},
"total": {
"name": "Total",
"min": 0.44,
"max": 0.48
},
"entities": [
{
"key": "jobCompute",
"name": "Job compute",
"savings": 0.46
},
{
"key": "allPurposeCompute",
"name": "All-Purpose compute",
"savings": 0
}
]
},
{
"key": "usages",
"name": "Usages",
"entities": [
{
"key": "allPurposeCompute",
"name": "All-Purpose compute",
"kpis": [
{
"key": "clusters",
"name": "Clusters",
"value": 18
},
{
"key": "sessions",
"name": "Sessions",
"value": 9
},
{
"key": "users",
"name": "Users",
"value": 6
}
]
},
{
"key": "jobCompute",
"name": "Job compute",
"kpis": [
{
"key": "jobs",
"name": "Jobs",
"value": 81
},
{
"key": "jobRuns",
"name": "Job Runs",
"value": 112
},
{
"key": "users",
"name": "Users",
"value": 8
}
]
}
]
},
{
"rating": 39,
"key": "costRating",
"name": "Cost Rating"
},
{
"rating": 3,
"key": "productivityRating",
"name": "Time to Insights"
}
]
}
Request
GET /api/v1.5/insights/cost-trendsUse this API to retrieve daily cost and savings trends for Databricks compute types over a selected time range.
Query Parameters
Parameter Name | Type | Example Value | Description |
|---|---|---|---|
startTime | string (ISO 8601) | 2025-10-04T00:00:00.000Z | Start of the time range in UTC |
endTime | string (ISO 8601) | 2025-11-02T23:59:59.999Z | End of the time range in UTC |
selectedValue | string | 30_d | Selected time interval, such as 7_d, 30_d, or 90_d |
Examples
curl -X GET \ -H "Authorization: JWT <token>" \ -H "Content-Type: application/json" \ -H "Accept: application/json" \ "http://yourdomain.com/api/v1.5/insights/cost-trends?endTime=2025-11-02T23:59:59.999Z&startTime=2025-10-04T00:00:00.000Z&selectedValue=30_d"
{ "status": "success", "costTrends": { "key": "costTrend", "name": "Total cost trends", "intervalType": "DAILY", "entities": [ { "name": "All-Purpose compute", "key": "allPurposeCompute", "data": [ { "cost": 2.53, "savings": 0, "savingsPercentage": 0, "costPercentage": 100, "date": 1759881600000 }, { "cost": 1.1, "savings": 0, "savingsPercentage": 0, "costPercentage": 100, "date": 1759968000000 }, { "cost": 4.19, "savings": 0, "savingsPercentage": 0, "costPercentage": 75.91, "date": 1760054400000 }, { "cost": 6.65, "savings": 0, "savingsPercentage": 0, "costPercentage": 100, "date": 1760313600000 }, { "cost": 0.3, "savings": 0, "savingsPercentage": 0, "costPercentage": 11.07, "date": 1760572800000 }, { "cost": 0.39, "savings": 0, "savingsPercentage": 0, "costPercentage": 23.21, "date": 1761264000000 }, { "cost": 34.36, "savings": 0.15, "savingsPercentage": 0.43, "costPercentage": 97.2, "date": 1761523200000 }, { "cost": 1.18, "savings": 0.09, "savingsPercentage": 7.76, "costPercentage": 24.38, "date": 1761782400000 }, { "cost": 11.48, "savings": 5.04, "savingsPercentage": 43.89, "costPercentage": 26.52, "date": 1761868800000 }, { "cost": 0.24, "savings": 0, "savingsPercentage": 0, "costPercentage": 100, "date": 1761955200000 } ] }, { "name": "Job compute", "key": "jobCompute", "data": [ { "cost": 1.33, "savings": 0, "savingsPercentage": 0, "costPercentage": 24.09, "date": 1760054400000 }, { "cost": 2.11, "savings": 0.38, "savingsPercentage": 18, "costPercentage": 100, "date": 1760400000000 }, { "cost": 0.03, "savings": 0.02, "savingsPercentage": 77.2, "costPercentage": 100, "date": 1760486400000 }, { "cost": 2.41, "savings": 0.46, "savingsPercentage": 19.06, "costPercentage": 88.93, "date": 1760572800000 }, { "cost": 2.8, "savings": 0.62, "savingsPercentage": 22.14, "costPercentage": 100, "date": 1760659200000 }, { "cost": 0.96, "savings": 0.15, "savingsPercentage": 15.68, "costPercentage": 100, "date": 1761177600000 }, { "cost": 1.29, "savings": 0.04, "savingsPercentage": 3.09, "costPercentage": 76.79, "date": 1761264000000 }, { "cost": 0.99, "savings": 0.17, "savingsPercentage": 17.09, "costPercentage": 2.8, "date": 1761523200000 }, { "cost": 1.39, "savings": 0.08, "savingsPercentage": 5.76, "costPercentage": 100, "date": 1761696000000 }, { "cost": 3.66, "savings": 2.3, "savingsPercentage": 62.82, "costPercentage": 75.62, "date": 1761782400000 }, { "cost": 31.8, "savings": 6.54, "savingsPercentage": 20.57, "costPercentage": 73.48, "date": 1761868800000 } ] } ] }}Request
GET /api/v1/app_store/api/v1/realized-savings-summaryUse this API to retrieve realized savings aggregated over a specified time bucket, including annualized, current‑period, and year‑to‑date values.
Query Parameters
Name | Type | Example Value | Description |
|---|---|---|---|
bucket | string | 30_d | Time bucket for which to fetch realized savings (for example, 7_d, 30_d, 90_d) |
Examples
curl -X GET \ -H "Authorization: JWT <token>" \ -H "Content-Type: application/json" \ -H "Accept: application/json" \ "http://yourdoamin.com/api/v1/app_store/api/v1/realized-savings-summary?bucket=30_d"
{"key": "realizedSavings", "name": "Realized Savings", "annualized": {"name": "Annualized", "value": 25.65, "start_date": "01/10/25", "end_date": "30/10/26"}, "total": {"name": "This Period", "value": 0.72, "start_date": "01/10/25", "end_date": "30/10/25"}, "ytd": {"name": "Year-to-Date", "value": 2.08, "start_date": "01/01/25", "end_date": "30/10/25"}, "entities": [{"key": "allPurposeClusters", "name": "Classic All-Purpose Clusters", "savings": 0, "breakdown": {"config": 0, "workload": 0}}, {"key": "jobs", "name": "Jobs", "savings": 0.72, "breakdown": {"config": 0.72, "workload": 0.0, "migration": 0.0}}]}TopX Summary
Request
GET /api/v1.5/insights/topx/summaryUse this API to retrieve the top X entities (for example, clusters or jobs) contributing to cost or savings over a selected time range.
Query Parameters
Name | Type | Example Value | Description |
|---|---|---|---|
startTime | string (ISO 8601) | 2025-10-04T00:00:00.000Z | Start of the time range in UTC |
endTime | string (ISO 8601) | 2025-11-02T23:59:59.999Z | End of the time range in UTC |
topx | number | 5 | Number of top entities to retrieve |
Example
curl -X GET \ -H "Authorization: JWT <token>" \ -H "Content-Type: application/json" \ -H "Accept: application/json" \ "http://yourdomain.com/api/v1.5/insights/topx/summary?startTime=2025-10-04T00:00:00.000Z&endTime=2025-11-02T23:59:59.999Z&topx=5"
{"status":"success","summary":[]}TopX Data
Request
GET /api/v1.5/insights/topx/dataQuery Parameters
Name | Type | Example Value | Description |
|---|---|---|---|
startTime | string (ISO 8601) | 2025-10-04T00:00:00.000Z | Start of the time range in UTC |
endTime | string (ISO 8601) | 2025-11-02T23:59:59.999Z | End of the time range in UTC |
type | string | MOST_MIGRATION_SAVINGS | Top X metric type (for example, MOST_MIGRATION_SAVINGS, LONGEST_RUNNING_CLUSTER) |
clusterType | string | allPurposeCompute | Databricks cluster type (for example, allPurposeCompute, jobCompute) |
topx | number | 5 | Number of top entities to return |
MOST_MIGRATION_SAVINGS
MOST_SAVINGS
MOST_EXPENSIVE_CLUSTER
LONGEST_RUNNING_CLUSTER
MOST_EXPENSIVE_USER
MOST_WASTED
Example
curl -X GET \ -H "Authorization: JWT <token>" \ -H "Content-Type: application/json" \ -H "Accept: application/json" \ "http://yourdomain.com/api/v1.5/insights/topx/data?startTime=2025-10-04T00:00:00.000Z&endTime=2025-11-02T23:59:59.999Z&type=MOST_MIGRATION_SAVINGS&clusterType=allPurposeCompute&topx=5"
{ "status": "success", "topx": [ { "key": "SAVINGS_allPurposeCompute_migration", "startTime": "2025-10-04T00:00:00.000Z", "endTime": "2025-11-02T23:59:59.000Z", "entities": [ { "key": "allPurposeCompute", "name": "All-Purpose compute", "cost": 4.1899999999999995, "savings": 0.09, "wastedCost": 0, "data": [ { "cost": 0.26, "savings": 0.09, "savingsPercentage": 35, "name": "venkatesh-123", "kpis": [ { "key": "duration", "label": "Duration", "value": 1184317 }, { "key": "annualCost", "label": "Annualized cost", "value": 3.11 }, { "key": "annualCostSavings", "label": "Annualized savings", "value": 1.12 } ] }, { "cost": 0.54, "savings": 0, "savingsPercentage": 0, "name": "Mallik_10.4", "kpis": [ { "key": "duration", "label": "Duration", "value": 2739552 }, { "key": "annualCost", "label": "Annualized cost", "value": 6.56 }, { "key": "annualCostSavings", "label": "Annualized savings", "value": 0 } ] }, { "cost": 0.38, "savings": 0, "savingsPercentage": 0, "name": "venkatesh's Personal Compute Cluster", "kpis": [ { "key": "duration", "label": "Duration", "value": 1760547 }, { "key": "annualCost", "label": "Annualized cost", "value": 4.62 }, { "key": "annualCostSavings", "label": "Annualized savings", "value": 0 } ] }, { "cost": 0.2, "savings": 0, "savingsPercentage": 0, "name": "venkatesh", "kpis": [ { "key": "duration", "label": "Duration", "value": 936466 }, { "key": "annualCost", "label": "Annualized cost", "value": 2.46 }, { "key": "annualCostSavings", "label": "Annualized savings", "value": 0 } ] }, { "cost": 2.81, "savings": 0, "savingsPercentage": 0, "name": "bohuslav-cluster", "kpis": [ { "key": "duration", "label": "Duration", "value": 11716256 }, { "key": "annualCost", "label": "Annualized cost", "value": 34.14 }, { "key": "annualCostSavings", "label": "Annualized savings", "value": 0 } ] } ] } ] } ]}Insights Savings (optimize tab)
Request
GET /api/v1.5/insights/savings
Use this API to retrieve savings and productivity insights, including total ROI, untapped savings, realized savings, and detailed insight categories for a selected time range.
Query Parameters
Name | Type | Example Value | Description |
|---|---|---|---|
startTime | string (ISO 8601) | 2025-10-04T00:00:00.000Z | Start of the time range in UTC |
endTime | string (ISO 8601) | 2025-11-02T23:59:59.999Z | End of the time range in UTC |
selectedValue | string | 30_d | Duration filter for the savings insights (for example, 7_d, 30_d, 90_d) |
Example
curl -X GET \ -H "Authorization: JWT <token>" \ -H "Content-Type: application/json" \ -H "Accept: application/json" \ "http://yourdomain.com/api/v1.5/insights/savings?endTime=2025-11-02T23:59:59.999Z&startTime=2025-10-04T00:00:00.000Z&selectedValue=30_d"
{ "status": "success", "savings": { "summary": [ { "key": "totalRoi", "title": "Total savings", "kpis": [ { "index": 0, "key": "potentialSavings", "name": "Untapped savings", "value": 8.3, "unit": "$", "annualized": 101.01 }, { "index": 1, "key": "realizedCostSavings", "name": " Realized savings", "value": 0.46, "unit": "$", "annualized": 5.6, "tooltip": "Savings are realized when recommendations are implemented during the selected timeframe" } ] }, { "key": "productivityBoost", "title": "Productivity boost", "kpis": [ { "index": 0, "key": "resourceEfficiencyHours", "name": " Resource efficiency", "value": 385.5, "unit": "hrs" }, { "index": 1, "key": "codeOptimizationHours", "name": " Code Optimization", "value": 189, "unit": "hrs" } ], "tooltip": "Calculated based on hours saved on manual troubleshooting effort for each insight category" } ], "details": [ { "index": 0, "key": "resourceEfficiencySavings", "name": "Instantly Realizable Savings", "startTime": 1759536000000, "endTime": 1762127999000, "kpis": [ { "index": 0, "key": "totalRoi", "name": "Total savings", "value": 8.76, "unit": "$", "annualized": 106.61 }, { "index": 1, "key": "potentialSavings", "name": "Untapped savings", "value": 8.3, "unit": "$", "annualized": 101.01 }, { "index": 2, "key": "realizedCostSavings", "name": " Realized savings", "value": 0.46, "unit": "$", "annualized": 5.6, "tooltip": "Savings are realized when recommendations are implemented during the selected timeframe" }, { "index": 3, "key": "productivityBoost", "name": "Productivity boost", "value": 385.5, "unit": "hrs" } ], "insights": [ { "key": "resourceScaling", "name": "Resource scaling insights", "value": 8.3, "metrics": [ { "key": "RightSizingEvent", "type": "Node rightsizing", "entityType": "Node rightsizing", "clusterType": "jobCompute", "desc": "Optimize cluster sizes for cost savings on recurring runs.", "savings": 2.91, "count": 20, "annualUntappedSavings": 35.41, "productivityBoost": 180, "totalRoi": 3.37, "realizedCostSavings": 0.46, "annualTotalRoi": 41.01 }, { "key": "PhotonBenefitEvent", "type": "Enable Photon", "entityType": "Enable Photon", "clusterType": "jobCompute", "desc": "Boost query performance with Photon acceleration", "savings": 1.86, "count": 5, "annualUntappedSavings": 22.64, "productivityBoost": 7.5, "totalRoi": 1.86, "realizedCostSavings": 0, "annualTotalRoi": 22.64 }, { "key": "RightSizingWithPhotonBenefitEvent", "type": "Rightsizing with Photon", "entityType": "Rightsizing with Photon", "clusterType": "jobCompute", "desc": "Right-size nodes with Photon for cost savings", "savings": 1.72, "count": 21, "annualUntappedSavings": 20.93, "productivityBoost": 189, "totalRoi": 1.72, "realizedCostSavings": 0, "annualTotalRoi": 20.93 }, { "key": "NodeDownsizingEvent", "type": "Node downsizing", "entityType": "Node downsizing", "clusterType": "allPurposeCompute", "desc": "Identify potential node downsizing opportunities to save costs.", "savings": 1.81, "count": 3, "annualUntappedSavings": 22.03, "productivityBoost": 9, "totalRoi": 1.81, "realizedCostSavings": 0, "annualTotalRoi": 22.03 } ] } ] }, { "index": 1, "key": "codeOptimization", "name": "Code optimization", "startTime": 1759536000000, "endTime": 1762127999000, "kpis": [ { "index": 0, "key": "productivityBoost", "name": "Productivity boost", "value": 189, "unit": "hrs" } ], "insights": [ { "key": "sqlInsights", "name": "SQL Insights", "value": 189, "metrics": [ { "key": "InefficientJoinConditionEvent", "type": "Inefficient join condition (All-Purpose Compute)", "entityType": "Inefficient join condition", "clusterType": "allPurposeCompute", "desc": "Remove bad join conditions for better query performance", "count": 2, "productivityBoost": 6 }, { "key": "InefficientJoinConditionEvent", "type": "Inefficient join condition (Job Compute)", "entityType": "Inefficient join condition", "clusterType": "jobCompute", "desc": "Remove bad join conditions for better query performance", "count": 7, "productivityBoost": 24 }, { "key": "InefficientJoinEvent", "type": "Inefficient join type (Job Compute)", "entityType": "Inefficient join type", "clusterType": "jobCompute", "desc": "Choose a better join type to reduce processing time", "count": 1, "productivityBoost": 6 }, { "key": "SlowSQLOperatorEvent", "type": "Slow SQL (Job Compute)", "entityType": "Slow SQL", "clusterType": "jobCompute", "desc": "Improve slow SQL operators for faster execution", "count": 5, "productivityBoost": 18 } ] }, { "key": "codeInsights", "name": "Code Insights", "value": 189, "metrics": [ { "key": "ContendedDriverEvent", "type": "Driver contention (Job Compute)", "entityType": "Driver contention", "clusterType": "jobCompute", "desc": "Resolve driver resource contention to avoid bottlenecks", "count": 16, "productivityBoost": 117 }, { "key": "ContendedDriverEvent", "type": "Driver contention (All-Purpose Compute)", "entityType": "Driver contention", "clusterType": "allPurposeCompute", "desc": "Resolve driver resource contention to avoid bottlenecks", "count": 3, "productivityBoost": 18 } ] } ] } ] }}