Update dashboard
Update a Dashboard.
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
- Token URL
- https://console.vantage.sh/account/profile
Path Parameters
Body
Update a Dashboard.
The title of the Dashboard.
The complete replacement list of widgets for the Dashboard. Omit widgets or send null to preserve every existing widget. When provided, include every report-backed and free text widget to keep; an empty array removes all widgets. Report-backed widgets use widgetable_token. Free text widgets use widgetable_type set to free_text and require content.
The tokens of the Saved Filters used in the Dashboard.
Determines how to group costs in the Dashboard.
cumulative, day, week, month Determines the date range in the Dashboard. Incompatible with 'start_date' and 'end_date' parameters.
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, The start date for the date range for costs in the Dashboard. ISO 8601 Formatted. Incompatible with 'date_interval' parameter.
The end date for the date range for costs in the Dashboard. ISO 8601 Formatted. Incompatible with 'date_interval' parameter.
The token of the Workspace the Dashboard belongs to. Required when updating widgets if the API token is associated with multiple Workspaces.
Response
Dashboard model
"dshbrd_abcd1234567890"
The title of the Dashboard.
"AWS Dashboard"
The widgets displayed in the Dashboard. Report-backed widgets include widgetable_token and settings. Free text widgets include widgetable_type set to free_text and content, omit widgetable_token, and include settings when a grid layout is persisted.
The tokens of the Saved Filters used in the Dashboard.
Determines how to group costs in the Dashboard.
cumulative, day, week, month Determines the date range for Reports in the Dashboard. Guaranteed to be set to 'custom' if 'start_date' and 'end_date' are set.
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 The date and time, in UTC, the Dashboard was created. ISO 8601 Formatted.
"2023-08-04T00:00:00Z"
The date and time, in UTC, the Dashboard was created. ISO 8601 Formatted.
"2023-08-04T00:00:00Z"
The token for the Workspace the Dashboard is a part of.
"wrkspc_abcd1234567890"
The start date for the date range for Reports in the Dashboard. ISO 8601 Formatted. Overwrites 'date_interval' if set.
"2023-08-04"
The end date for the date range for Reports in the Dashboard. ISO 8601 Formatted. Overwrites 'date_interval' if set.
"2023-09-04"