Dashboard

Manage UI Dashboards.

Create

Create a new dashboard.

Endpoint

POST /dashboard/create

Authorized User Role

user

Request Body

Field	Type	Required	Default	Notes
css	array			CSS styles for the dashboard.
emulate	string			Emulate device type when designing.
fixed	boolean			Prevent runtime changes to the dashboard.
framed	boolean			Show a frame around dashboard widgets.
layout	string		grid
live	boolean			Enable live data updates.
name	string	yes		Dashboard name.
range	object			Override time range for the dashboard.
refresh	number			Refresh rate in seconds.
toolbar	boolean			Show a toolbar on the dashboard.
type	string			Board type: "page" or "dashboard".
widgets	array			Array of widgets.
widgetCss	array			CSS styles for dashboard widgets.

Widgets

Field	Type	Default	Notes
action	object	{}	Widget action configuration.
accept	string		File input accept type.
anchor	object	{}	Widget anchor to window.
axes	object		Graph axes.
css	array		CSS styles for the widget.
dashboard	string		Target dashboard to select.
datetime	string		Date input datetime.
dimensions	object	{}	Metric and data dimensions.
field	string		Database model field.
fields	array		Database table fields.
fixed	boolean		Prevent runtime changes to the widget.
form	string		Form input type.
footer	string		Widget footer text.
format	string		Message format.
framed	boolean		Show a frame around the widget.
header	string		Widget header text.
height	string		Widget height in pixels.
id	string		Unique widget UUID.
input	string		Input type.
items	string		Input selection items.
label	string		Input label.
legend	object		Reserved.
left	string		Left position (x coord).
limit	number		Items limit.
max	number		Maximum data value.
min	number		Minimum data value.
metric	string		CloudWatch Metric.
model	string		Database model name.
multiple	boolean		Allow multiple input selections.
namespace	string		Metric namespace.
options	object		Custom options.
pivot	string		Table pivot column.
placeholder	string		Input placeholder.
prefix	string		Prefix text.
range	object	{}	Override time range for the widget.
rows	number		Number of rows in textarea input.
show	string		Expression to determine if the widget is visible.
statistic	string		Math statistic.
subtitle	string		Table subtitle.
suffix	string		Suffix text.
text	string		Static widget value.
ticks	number		Number of axis ticks on x axis.
timezone	string		Date input timezone.
title	string		Widget title.
top	string		Top position (y coord).
type	string		Widget type.
units	string		Metric units.
url	string		Image URL.
validate	string		Input validation RegExp.
width	string		Widget width in pixels.
z	number		Z order.

Action

Widget action configuration.

Field	Type	Notes
type	string	Action type.
target	string	Action target.
conditions	array	Automation Action Conditions.

Range

Override time range for the widget.

Field	Type	Default	Notes
anchor	string	relative	Anchor type to be "absolute" or "relative".
start	date		Start date.
period	number	2419200	Time period in seconds.
refresh	number	60	Refresh rate in seconds.
override	boolean		Override the dashboard user selected time range.
timezone	string	local	Timezone to display the data in.

Response

Dashboard Record.

Field	Type	Notes
accountId	string	Owning account ID.
css	array	CSS styles for the dashboard.
emulate	string	Emulate device type when designing.
fixed	boolean	Prevent runtime changes to the dashboard.
framed	boolean	Show a frame around dashboard widgets.
id	string	Unique dashboard ID.
layout	string	Dashboard layout.
live	boolean	Enable live data updates.
name	string	Dashboard name.
range	object	Time range for the dashboard.
refresh	number	Refresh rate in seconds.
toolbar	boolean	Show a toolbar on the dashboard.
type	string	Dashboard type.
widgetCss	array	CSS styles for dashboard widgets.
widgets	array	Array of widgets.

Range

Time range for the dashboard.

Field	Type	Notes
anchor	string	Anchor type to be "absolute" or "relative".
start	date	Start date.
period	number	Time period in seconds.
refresh	number	Refresh rate in seconds.
override	boolean	Override the dashboard user selected time range.
timezone	string	Timezone to display the data in.

Widgets

Field	Type	Notes
action	object	Widget action configuration.
accept	string	File input accept type.
anchor	object	Widget anchor to window.
axes	object	Graph axes.
css	array	CSS styles for the widget.
dashboard	string	Target dashboard to select.
datetime	string	Date input datetime.
dimensions	object	Metric and data dimensions.
field	string	Database model field.
fields	array	Database table fields.
fixed	boolean	Prevent runtime changes to the widget.
form	string	Form input type.
footer	string	Widget footer text.
format	string	Message format.
framed	boolean	Show a frame around the widget.
header	string	Widget header text.
height	string	Widget height in pixels.
id	string	Unique widget UUID.
input	string	Input type.
items	string	Input selection items.
label	string	Input label.
legend	object	Reserved.
left	string	Left position (x coord).
limit	number	Items limit.
max	number	Maximum data value.
min	number	Minimum data value.
metric	string	CloudWatch Metric.
model	string	Database model name.
multiple	boolean	Allow multiple input selections.
namespace	string	Metric namespace.
options	object	Custom options.
pivot	string	Table pivot column.
placeholder	string	Input placeholder.
prefix	string	Prefix text.
range	object	Override time range for the widget.
rows	number	Number of rows in textarea input.
show	string	Expression to determine if the widget is visible.
statistic	string	Math statistic.
subtitle	string	Table subtitle.
suffix	string	Suffix text.
text	string	Static widget value.
ticks	number	Number of axis ticks on x axis.
timezone	string	Date input timezone.
title	string	Widget title.
top	string	Top position (y coord).
type	string	Widget type.
units	string	Metric units.
url	string	Image URL.
validate	string	Input validation RegExp.
width	string	Widget width in pixels.
z	number	Z order.

Action

Widget action configuration.

Field	Type	Notes
type	string	Action type.
target	string	Action target.
conditions	array	Automation Action Conditions.

Range

Override time range for the widget.

Field	Type	Notes
anchor	string	Anchor type to be "absolute" or "relative".
start	date	Start date.
period	number	Time period in seconds.
refresh	number	Refresh rate in seconds.
override	boolean	Override the dashboard user selected time range.
timezone	string	Timezone to display the data in.

Find

Find dashboards by matching properties and query parameters.

Endpoint

POST /dashboard/find

Authorized User Role

user

Response

Dashboard Record.

Field	Type	Notes
accountId	string	Owning account ID.
css	array	CSS styles for the dashboard.
emulate	string	Emulate device type when designing.
fixed	boolean	Prevent runtime changes to the dashboard.
framed	boolean	Show a frame around dashboard widgets.
id	string	Unique dashboard ID.
layout	string	Dashboard layout.
live	boolean	Enable live data updates.
name	string	Dashboard name.
range	object	Time range for the dashboard.
refresh	number	Refresh rate in seconds.
toolbar	boolean	Show a toolbar on the dashboard.
type	string	Dashboard type.
widgetCss	array	CSS styles for dashboard widgets.
widgets	array	Array of widgets.

Range

Time range for the dashboard.

Field	Type	Notes
anchor	string	Anchor type to be "absolute" or "relative".
start	date	Start date.
period	number	Time period in seconds.
refresh	number	Refresh rate in seconds.
override	boolean	Override the dashboard user selected time range.
timezone	string	Timezone to display the data in.

Widgets

Field	Type	Notes
action	object	Widget action configuration.
accept	string	File input accept type.
anchor	object	Widget anchor to window.
axes	object	Graph axes.
css	array	CSS styles for the widget.
dashboard	string	Target dashboard to select.
datetime	string	Date input datetime.
dimensions	object	Metric and data dimensions.
field	string	Database model field.
fields	array	Database table fields.
fixed	boolean	Prevent runtime changes to the widget.
form	string	Form input type.
footer	string	Widget footer text.
format	string	Message format.
framed	boolean	Show a frame around the widget.
header	string	Widget header text.
height	string	Widget height in pixels.
id	string	Unique widget UUID.
input	string	Input type.
items	string	Input selection items.
label	string	Input label.
legend	object	Reserved.
left	string	Left position (x coord).
limit	number	Items limit.
max	number	Maximum data value.
min	number	Minimum data value.
metric	string	CloudWatch Metric.
model	string	Database model name.
multiple	boolean	Allow multiple input selections.
namespace	string	Metric namespace.
options	object	Custom options.
pivot	string	Table pivot column.
placeholder	string	Input placeholder.
prefix	string	Prefix text.
range	object	Override time range for the widget.
rows	number	Number of rows in textarea input.
show	string	Expression to determine if the widget is visible.
statistic	string	Math statistic.
subtitle	string	Table subtitle.
suffix	string	Suffix text.
text	string	Static widget value.
ticks	number	Number of axis ticks on x axis.
timezone	string	Date input timezone.
title	string	Widget title.
top	string	Top position (y coord).
type	string	Widget type.
units	string	Metric units.
url	string	Image URL.
validate	string	Input validation RegExp.
width	string	Widget width in pixels.
z	number	Z order.

Action

Widget action configuration.

Field	Type	Notes
type	string	Action type.
target	string	Action target.
conditions	array	Automation Action Conditions.

Range

Override time range for the widget.

Field	Type	Notes
anchor	string	Anchor type to be "absolute" or "relative".
start	date	Start date.
period	number	Time period in seconds.
refresh	number	Refresh rate in seconds.
override	boolean	Override the dashboard user selected time range.
timezone	string	Timezone to display the data in.

Get

Get a matching dashboard.

Endpoint

POST /dashboard/get

Authorized User Role

user

Request Body

Field	Type	Notes
id	string	Dashboard ID.
name	string	Dashboard name.

Response

Object Record.

Field	Type	Notes
accountId	string	Owning account ID.
css	array	CSS styles for the dashboard.
emulate	string	Emulate device type when designing.
fixed	boolean	Prevent runtime changes to the dashboard.
framed	boolean	Show a frame around dashboard widgets.
id	string	Unique dashboard ID.
layout	string	Dashboard layout.
live	boolean	Enable live data updates.
name	string	Dashboard name.
range	object	Time range for the dashboard.
refresh	number	Refresh rate in seconds.
toolbar	boolean	Show a toolbar on the dashboard.
type	string	Dashboard type.
widgetCss	array	CSS styles for dashboard widgets.
widgets	array	Array of widgets.

Range

Time range for the dashboard.

Field	Type	Notes
anchor	string	Anchor type to be "absolute" or "relative".
start	date	Start date.
period	number	Time period in seconds.
refresh	number	Refresh rate in seconds.
override	boolean	Override the dashboard user selected time range.
timezone	string	Timezone to display the data in.

Widgets

Field	Type	Notes
action	object	Widget action configuration.
accept	string	File input accept type.
anchor	object	Widget anchor to window.
axes	object	Graph axes.
css	array	CSS styles for the widget.
dashboard	string	Target dashboard to select.
datetime	string	Date input datetime.
dimensions	object	Metric and data dimensions.
field	string	Database model field.
fields	array	Database table fields.
fixed	boolean	Prevent runtime changes to the widget.
form	string	Form input type.
footer	string	Widget footer text.
format	string	Message format.
framed	boolean	Show a frame around the widget.
header	string	Widget header text.
height	string	Widget height in pixels.
id	string	Unique widget UUID.
input	string	Input type.
items	string	Input selection items.
label	string	Input label.
legend	object	Reserved.
left	string	Left position (x coord).
limit	number	Items limit.
max	number	Maximum data value.
min	number	Minimum data value.
metric	string	CloudWatch Metric.
model	string	Database model name.
multiple	boolean	Allow multiple input selections.
namespace	string	Metric namespace.
options	object	Custom options.
pivot	string	Table pivot column.
placeholder	string	Input placeholder.
prefix	string	Prefix text.
range	object	Override time range for the widget.
rows	number	Number of rows in textarea input.
show	string	Expression to determine if the widget is visible.
statistic	string	Math statistic.
subtitle	string	Table subtitle.
suffix	string	Suffix text.
text	string	Static widget value.
ticks	number	Number of axis ticks on x axis.
timezone	string	Date input timezone.
title	string	Widget title.
top	string	Top position (y coord).
type	string	Widget type.
units	string	Metric units.
url	string	Image URL.
validate	string	Input validation RegExp.
width	string	Widget width in pixels.
z	number	Z order.

Action

Widget action configuration.

Field	Type	Notes
type	string	Action type.
target	string	Action target.
conditions	array	Automation Action Conditions.

Range

Override time range for the widget.

Field	Type	Notes
anchor	string	Anchor type to be "absolute" or "relative".
start	date	Start date.
period	number	Time period in seconds.
refresh	number	Refresh rate in seconds.
override	boolean	Override the dashboard user selected time range.
timezone	string	Timezone to display the data in.

Remove

Remove a dashboard.

Endpoint

POST /dashboard/remove

Authorized User Role

user

Request Body

Field	Type	Notes
id	string	Dashboard ID.

Update

Update a dashboard.

Endpoint

POST /dashboard/update

Authorized User Role

user

Request Body

Field	Type	Required	Default	Notes
css	array			CSS styles for the dashboard.
emulate	string			Emulate device type when designing.
fixed	boolean			Prevent runtime changes to the dashboard.
framed	boolean			Show a frame around dashboard widgets.
id	string	yes		Dashboard ID.
layout	string			Dashboard layout.
live	boolean			Enable live data updates.
name	string			Dashboard name.
range	object			Override time range for the dashboard.
refresh	number			Refresh rate in seconds.
toolbar	boolean			Show a toolbar on the dashboard.
type	string			Board type: "page" or "dashboard".
widgets	array			Array of widgets.
widgetCss	array

Widgets

Field	Type	Default	Notes
action	object	{}	Widget action configuration.
accept	string		File input accept type.
anchor	object	{}	Widget anchor to window.
axes	object		Graph axes.
css	array		CSS styles for the widget.
dashboard	string		Target dashboard to select.
datetime	string		Date input datetime.
dimensions	object	{}	Metric and data dimensions.
field	string		Database model field.
fields	array		Database table fields.
fixed	boolean		Prevent runtime changes to the widget.
form	string		Form input type.
footer	string		Widget footer text.
format	string		Message format.
framed	boolean		Show a frame around the widget.
header	string		Widget header text.
height	string		Widget height in pixels.
id	string		Unique widget UUID.
input	string		Input type.
items	string		Input selection items.
label	string		Input label.
legend	object		Reserved.
left	string		Left position (x coord).
limit	number		Items limit.
max	number		Maximum data value.
min	number		Minimum data value.
metric	string		CloudWatch Metric.
model	string		Database model name.
multiple	boolean		Allow multiple input selections.
namespace	string		Metric namespace.
options	object		Custom options.
pivot	string		Table pivot column.
placeholder	string		Input placeholder.
prefix	string		Prefix text.
range	object	{}	Override time range for the widget.
rows	number		Number of rows in textarea input.
show	string		Expression to determine if the widget is visible.
statistic	string		Math statistic.
subtitle	string		Table subtitle.
suffix	string		Suffix text.
text	string		Static widget value.
ticks	number		Number of axis ticks on x axis.
timezone	string		Date input timezone.
title	string		Widget title.
top	string		Top position (y coord).
type	string		Widget type.
units	string		Metric units.
url	string		Image URL.
validate	string		Input validation RegExp.
width	string		Widget width in pixels.
z	number		Z order.

Action

Widget action configuration.

Field	Type	Notes
type	string	Action type.
target	string	Action target.
conditions	array	Automation Action Conditions.

Range

Override time range for the widget.

Field	Type	Default	Notes
anchor	string	relative	Anchor type to be "absolute" or "relative".
start	date		Start date.
period	number	2419200	Time period in seconds.
refresh	number	60	Refresh rate in seconds.
override	boolean		Override the dashboard user selected time range.
timezone	string	local	Timezone to display the data in.

Response

Dashboard Record.

Field	Type	Notes
accountId	string	Owning account ID.
css	array	CSS styles for the dashboard.
emulate	string	Emulate device type when designing.
fixed	boolean	Prevent runtime changes to the dashboard.
framed	boolean	Show a frame around dashboard widgets.
id	string	Unique dashboard ID.
layout	string	Dashboard layout.
live	boolean	Enable live data updates.
name	string	Dashboard name.
range	object	Time range for the dashboard.
refresh	number	Refresh rate in seconds.
toolbar	boolean	Show a toolbar on the dashboard.
type	string	Dashboard type.
widgetCss	array	CSS styles for dashboard widgets.
widgets	array	Array of widgets.

Range

Time range for the dashboard.

Field	Type	Notes
anchor	string	Anchor type to be "absolute" or "relative".
start	date	Start date.
period	number	Time period in seconds.
refresh	number	Refresh rate in seconds.
override	boolean	Override the dashboard user selected time range.
timezone	string	Timezone to display the data in.

Widgets

Field	Type	Notes
action	object	Widget action configuration.
accept	string	File input accept type.
anchor	object	Widget anchor to window.
axes	object	Graph axes.
css	array	CSS styles for the widget.
dashboard	string	Target dashboard to select.
datetime	string	Date input datetime.
dimensions	object	Metric and data dimensions.
field	string	Database model field.
fields	array	Database table fields.
fixed	boolean	Prevent runtime changes to the widget.
form	string	Form input type.
footer	string	Widget footer text.
format	string	Message format.
framed	boolean	Show a frame around the widget.
header	string	Widget header text.
height	string	Widget height in pixels.
id	string	Unique widget UUID.
input	string	Input type.
items	string	Input selection items.
label	string	Input label.
legend	object	Reserved.
left	string	Left position (x coord).
limit	number	Items limit.
max	number	Maximum data value.
min	number	Minimum data value.
metric	string	CloudWatch Metric.
model	string	Database model name.
multiple	boolean	Allow multiple input selections.
namespace	string	Metric namespace.
options	object	Custom options.
pivot	string	Table pivot column.
placeholder	string	Input placeholder.
prefix	string	Prefix text.
range	object	Override time range for the widget.
rows	number	Number of rows in textarea input.
show	string	Expression to determine if the widget is visible.
statistic	string	Math statistic.
subtitle	string	Table subtitle.
suffix	string	Suffix text.
text	string	Static widget value.
ticks	number	Number of axis ticks on x axis.
timezone	string	Date input timezone.
title	string	Widget title.
top	string	Top position (y coord).
type	string	Widget type.
units	string	Metric units.
url	string	Image URL.
validate	string	Input validation RegExp.
width	string	Widget width in pixels.
z	number	Z order.

Action

Widget action configuration.

Field	Type	Notes
type	string	Action type.
target	string	Action target.
conditions	array	Automation Action Conditions.

Range

Override time range for the widget.

Field	Type	Notes
anchor	string	Anchor type to be "absolute" or "relative".
start	date	Start date.
period	number	Time period in seconds.
refresh	number	Refresh rate in seconds.
override	boolean	Override the dashboard user selected time range.
timezone	string	Timezone to display the data in.