Skip to main content
POST
/
kubernetes_efficiency_reports
/
data_exports
Generate Kubernetes efficiency data export
curl --request POST \
  --url https://api.vantage.sh/v2/kubernetes_efficiency_reports/data_exports \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "kubernetes_efficiency_report_token": "<string>",
  "filter": "<string>",
  "workspace_token": "<string>",
  "start_date": "<string>",
  "end_date": "<string>",
  "date_bin": "day"
}
'
{
  "token": "dta_xprt_abcd1234567890",
  "status": "pending",
  "created_at": "2025-03-20T12:00:00Z",
  "export_type": "cost_report",
  "manifest": {
    "files": "",
    "completed_at": "2025-03-20T12:00:00Z",
    "valid_until": "2025-03-20T12:00:00Z"
  },
  "attributes": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
groupings
string[]

Group the results by specific field(s). Valid groupings: cluster_id, namespace, labeled, category, pod, label, label:<label_name>.

Body

application/json
​
kubernetes_efficiency_report_token
string

The KubernetesEfficiencyReport token. If not provided, the default report for the workspace will be used.

​
filter
string

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

​
workspace_token
string

The token of the Workspace to export data from. Ignored if 'kubernetes_efficiency_report_token' is set. Required if the API token is associated with multiple Workspaces.

​
start_date
string

First date you would like to filter data from. ISO 8601 formatted.

​
end_date
string

Last date you would like to filter data to. ISO 8601 formatted.

​
date_bin
enum<string>

The date bin of the data. Defaults to the report's default or day.

Available options:
day,
week,
month

Response

The data export has been queued and will be available at the location specified in the Location header.

DataExport model

​
token
string
Example:

"dta_xprt_abcd1234567890"

​
status
string
Example:

"pending"

​
created_at
string
Example:

"2025-03-20T12:00:00Z"

​
export_type
string
Example:

"cost_report"

​
manifest
object
​
attributes
string