Skip to main content
POST
/
dashboards
Create dashboard
curl --request POST \
  --url https://api.vantage.sh/v2/dashboards \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "widgets": [
    {
      "widgetable_token": "<string>",
      "title": "<string>",
      "settings": {
        "display_type": "table"
      }
    }
  ],
  "saved_filter_tokens": [
    "<string>"
  ],
  "date_bin": "cumulative",
  "date_interval": "this_month",
  "start_date": "<string>",
  "end_date": "<string>",
  "workspace_token": "<string>"
}
'
{
  "token": "dshbrd_7e272e8d3de34719",
  "title": "New Dashboard",
  "widget_tokens": [
    "fncl_cmnt_rprt_d4743c186c130e30",
    "kbnts_eff_rprt_892d1566bd543b67",
    "rprt_750074c1b25b372a"
  ],
  "widgets": [
    {
      "widgetable_token": "fncl_cmnt_rprt_d4743c186c130e30",
      "title": "All Financial Commitments",
      "settings": {
        "display_type": "chart"
      }
    },
    {
      "widgetable_token": "kbnts_eff_rprt_892d1566bd543b67",
      "title": "All Kubernetes Nodes Efficiency",
      "settings": {
        "display_type": "table"
      }
    },
    {
      "widgetable_token": "rprt_750074c1b25b372a",
      "title": "Azure Cost Report",
      "settings": {
        "display_type": "chart"
      }
    }
  ],
  "saved_filter_tokens": [
    "svd_fltr_3f45aefa131861ac"
  ],
  "date_bin": "week",
  "date_interval": "this_month",
  "start_date": "2023-08-01",
  "end_date": "2023-08-31",
  "created_at": "2023-08-15T00:00:00Z",
  "updated_at": "2023-08-15T00:00:00Z",
  "workspace_token": "wrkspc_08e043cc14ced776"
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json

Create a Dashboard.

​
title
string
required

The title of the Dashboard.

​
widgets
object[]

The widgets to add to the Dashboard. Currently supports CostReport, ResourceReport, KubernetesEfficiencyReport, and FinancialCommitmentReport.

​
saved_filter_tokens
string[]

The tokens of the Saved Filters used in the Dashboard.

​
date_bin
enum<string>

Determines how to group costs in the Dashboard.

Available options:
cumulative,
day,
week,
month
​
date_interval
enum<string>

Determines the date range in the Dashboard. Incompatible with 'start_date' and 'end_date' parameters.

Available options:
this_month,
last_7_days,
last_30_days,
last_month,
last_3_months,
last_6_months,
custom,
last_12_months,
last_24_months,
last_36_months,
next_month,
next_3_months,
next_6_months,
next_12_months,
year_to_date,
last_3_days,
last_14_days
​
start_date
string

The start date for the date range for costs in the Dashboard. ISO 8601 Formatted. Incompatible with 'date_interval' parameter.

​
end_date
string

The end date for the date range for costs in the Dashboard. ISO 8601 Formatted. Incompatible with 'date_interval' parameter.

​
workspace_token
string

The token of the Workspace to add the Dashboard to. Required if the API token is associated with multiple Workspaces.

Response

Dashboard model

​
token
string
Example:

"dshbrd_abcd1234567890"

​
title
string

The title of the Dashboard.

Example:

"AWS Dashboard"

​
widgets
object[]
​
saved_filter_tokens
string[]

The tokens of the Saved Filters used in the Dashboard.

​
date_bin
enum<string>

Determines how to group costs in the Dashboard.

Available options:
cumulative,
day,
week,
month
​
date_interval
enum<string>

Determines the date range for Reports in the Dashboard. Guaranteed to be set to 'custom' if 'start_date' and 'end_date' are set.

Available options:
this_month,
last_7_days,
last_30_days,
last_month,
last_3_months,
last_6_months,
custom,
last_12_months,
last_24_months,
last_36_months,
next_month,
next_3_months,
next_6_months,
next_12_months,
year_to_date,
last_3_days,
last_14_days
​
start_date
string

The start date for the date range for Reports in the Dashboard. ISO 8601 Formatted. Overwrites 'date_interval' if set.

Example:

"2023-08-04"

​
end_date
string

The end date for the date range for Reports in the Dashboard. ISO 8601 Formatted. Overwrites 'date_interval' if set.

Example:

"2023-09-04"

​
created_at
string

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

Example:

"2023-08-04T00:00:00Z"

​
updated_at
string

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

Example:

"2023-08-04T00:00:00Z"

​
workspace_token
string

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

Example:

"wrkspc_abcd1234567890"