Organization Dashboard API

The overview and dashboard endpoints return organization-wide aggregates. Use them to build summary views, cost trend charts, and top-level health indicators.

Required scope: overview:read

Organization Overview

text

GET /v1/overview

Returns a snapshot of your organization's current state: cluster counts, total resource usage, costs, and recommendation counts.

Example Request

bash

curl -H "Authorization: Bearer ka_your_api_key" \
  https://public-api.kubeadapt.io/v1/overview

Example Response

json

{
  "organization_id": "org-xyz123",
  "cluster_count": 3,
  "connected_cluster_count": 3,
  "total_nodes": 28,
  "total_pods": 680,
  "total_workloads": 112,
  "total_hourly_cost": 342.8,
  "total_monthly_cost": 250244.0,
  "potential_monthly_savings": 38500.0,
  "avg_cpu_utilization": 47.2,
  "avg_memory_utilization": 61.8,
  "recommendation_count": 14,
  "mtd_actual_cost": 118200.0,
  "run_rate": 252000.0,
  "efficiency_score": 0.74
}

Response Fields

Field	Type	Description
`organization_id`	string	Your organization identifier
`cluster_count`	integer	Total number of clusters registered
`connected_cluster_count`	integer	Clusters currently sending data
`total_nodes`	integer	Total nodes across all clusters
`total_pods`	integer	Total running pods across all clusters
`total_workloads`	integer	Total workloads across all clusters
`total_hourly_cost`	float	Current estimated hourly cost in USD
`total_monthly_cost`	float	Projected monthly cost in USD
`potential_monthly_savings`	float	Total potential monthly savings from open recommendations
`avg_cpu_utilization`	float	Average CPU utilization across all clusters, as a percentage
`avg_memory_utilization`	float	Average memory utilization across all clusters, as a percentage
`recommendation_count`	integer	Total open recommendations
`mtd_actual_cost`	float	Month-to-date actual spend in USD
`run_rate`	float	Projected monthly spend based on current usage
`efficiency_score`	float	Organization-wide efficiency score (0 to 1)

Dashboard

text

GET /v1/dashboard

Returns top clusters by spend and month-to-date metrics. Use this to build summary views and identify the highest-cost clusters.

Example Request

bash

curl -H "Authorization: Bearer ka_your_api_key" \
  https://public-api.kubeadapt.io/v1/dashboard

Example Response

json

{
  "organization_id": "org-xyz123",
  "total_monthly_cost": 250244.0,
  "total_hourly_cost": 342.8,
  "potential_monthly_savings": 38500.0,
  "efficiency_score": 0.74,
  "cluster_count": 3,
  "node_count": 28,
  "pod_count": 680,
  "mtd_actual_cost": 118200.0,
  "run_rate": 252000.0,
  "days_elapsed": 15,
  "days_in_month": 31,
  "top_clusters": [
    {
      "cluster_id": "cls-abc123",
      "cluster_name": "prod-us-east",
      "hourly_cost": 125.5,
      "efficiency": 0.78
    },
    {
      "cluster_id": "cls-def456",
      "cluster_name": "prod-eu-west",
      "hourly_cost": 118.2,
      "efficiency": 0.71
    }
  ],
  "total_recommendations": 14
}

Response Fields

Field	Type	Description
`organization_id`	string	Your organization identifier
`total_monthly_cost`	float	Projected monthly cost in USD
`total_hourly_cost`	float	Current estimated hourly cost in USD
`potential_monthly_savings`	float	Total potential monthly savings from open recommendations
`efficiency_score`	float	Organization-wide efficiency score (0 to 1)
`cluster_count`	integer	Total number of clusters
`node_count`	integer	Total nodes across all clusters
`pod_count`	integer	Total running pods across all clusters
`mtd_actual_cost`	float	Month-to-date actual spend in USD
`run_rate`	float	Projected monthly spend based on current usage
`days_elapsed`	integer	Number of days elapsed in the current month
`days_in_month`	integer	Total days in the current month
`top_clusters`	array	Clusters sorted by hourly cost, highest first
`top_clusters[].cluster_id`	string	Cluster identifier
`top_clusters[].cluster_name`	string	Cluster display name
`top_clusters[].hourly_cost`	float	Current estimated hourly cost
`top_clusters[].efficiency`	float	Cluster efficiency score (0 to 1)
`total_recommendations`	integer	Total open recommendations

Clusters - Per-cluster details and dashboard metrics
Cost Allocation - Cost breakdown by team and department
Recommendations - Cost optimization suggestions

Organization Overview

Example Request

Example Response

Response Fields

Dashboard

Example Request

Example Response

Response Fields

Related