Skip to main content
GET
/
kubernetes_efficiency_reports
/
{kubernetes_efficiency_report_token}
Get Kubernetes efficiency report by token
curl --request GET \
  --url https://api.vantage.sh/v2/kubernetes_efficiency_reports/{kubernetes_efficiency_report_token} \
  --header 'Authorization: Bearer <token>'
{
  "token": "kbnts_eff_rprt_8f8b9caaffee230b",
  "title": "+1 disrupt.",
  "default": false,
  "created_at": "2024-10-25T21:20:43Z",
  "workspace_token": "wrkspc_d6ab5f555d9bd0b5",
  "user_token": null,
  "start_date": "2024-10-01",
  "end_date": "2024-10-31",
  "date_interval": "this_month",
  "date_bucket": "day",
  "aggregated_by": "idle_cost",
  "groupings": "cluster_id"
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
kubernetes_efficiency_report_token
string
required

Response

KubernetesEfficiencyReport model

​
token
string
​
title
string

The title of the KubernetesEfficiencyReport.

Example:

"Acme123 Kubernetes Efficiency Metrics"

​
default
boolean

Indicates whether the KubernetesEfficiencyReport is the default report.

​
created_at
string

The date and time, in UTC, the report was created. ISO 8601 Formatted.

Example:

"2024-03-19T00:00:00Z"

​
workspace_token
string

The token for the Workspace the KubernetesEfficiencyReport is a part of.

​
user_token
string

The token for the User who created this KubernetesEfficiencyReport.

​
start_date
string

The start date for the KubernetesEfficiencyReport. Only set for custom date ranges. ISO 8601 Formatted.

Example:

"2024-03-01"

​
end_date
string

The end date for the KubernetesEfficiencyReport. Only set for custom date ranges. ISO 8601 Formatted.

Example:

"2024-03-20"

​
date_interval
string

The date range for the KubernetesEfficiencyReport. Only present if a custom date range is not specified.

Example:

"last_month"

​
date_bucket
string

How costs are grouped and displayed in the KubernetesEfficiencyReport. Possible values: day, week, month.

Example:

"month"

​
aggregated_by
string

How costs are aggregated by. Possible values: idle_cost, amount, cost_efficiency.

​
groupings
string

Grouping values for aggregating costs on the KubernetesEfficiencyReport. Valid groupings: cluster_id, namespace, labeled, category, pod, label, label:<label_name>.

Example:

"cluster_id, namespace"

​
filter
string

The filter applied to the KubernetesEfficiencyReport. Additional documentation available at https://docs.vantage.sh/vql.