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			Widgets.
widgetCss	array			CSS styles for dashboard widgets.

Widgets

Field	Type	Default	Notes
actions	array		Widget actions.
accept	string		File input accept type.
anchor	object	{}	Anchor side.
axes	object		Graph axes.
cloudId	string		Cloud ID.
columns	array		Table columns to display.
css	array		CSS styles.
datetime	string		Date input datetime.
defaultValue	string		Default value.
dimensions	object	{}	Metric and data dimensions.
field	string		Database data field.
fields	array		Database fields to fetch.
fixed	boolean		Lock down changes.
form	string		Input form name.
formField	string		Input form field.
footer	string		Widget footer.
format	string		Text and numeric format.
framed	boolean		Widget has a frame.
header	string		Widget header text.
height	string		Widget height in pixels.
id	string		Unique widget UUID within the dashboard only.
icon	string		Icon to display.
input	string		Input type.
items	string		Input items (JSON).
label	string		Input label.
legend	object		Widget legend.
left	string		Fraction of viewport (0-1) or "rest".
limit	number		Item limit.
max	number		Maximum data value.
min	number		Minimum data value.
metric	string		CloudWatch Metric.
model	string		Database model.
multiple	boolean		Multiple selection.
namespace	string		Metric namespace.
options	object		Custom options.
pageSize	number		Table page size.
pivot	string		Table pivot column.
placeholder	string		Input placeholder.
prefix	string		Value prefix.
presentation	string		Presentation style.
range	object	{}	Time range.
region	string		Region for metrics.
rows	number		Text area rows.
show	string		Show expression.
statistic	string		Math stat.
subtitle	string		Table subtitle.
suffix	string		Value suffix.
text	string		Static widget value.
ticks	number		Number of ticks.
timezone	string		Date input timezeon.
title	string		Widget title.
top	string		Top position.
type	string		Widget type.
units	string		Metric units.
url	string		Resource URL.
validate	string		RegExp validation.
width	string		Fraction of viewport (0-1).
z	number		Z order.

Actions

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

Range

Time range.

Field	Type	Default
anchor	string	relative
start	date
period	number	2419200
refresh	number	60
override	boolean	false
timezone	string	local

Query String Options

Field	Type	Default	Role	Notes
index	string		owner	Database index name: primary or gs1.
limit	number			Number of items to retrieve.
next	object			Pagination token for the next page.
prev	object			Pagination token for the previous page.

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	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
actions	array	Widget actions.
accept	string	File input accept type.
anchor	object	Anchor side.
axes	object	Graph axes.
cloudId	string	Cloud ID.
columns	array	Table columns to display.
css	array	CSS styles.
datetime	string	Date input datetime.
defaultValue	string	Default value.
dimensions	object	Metric and data dimensions.
field	string	Database data field.
fields	array	Database fields to fetch.
fixed	boolean	Lock down changes.
form	string	Input form name.
formField	string	Input form field.
footer	string	Widget footer.
format	string	Text and numeric format.
framed	boolean	Widget has a frame.
header	string	Widget header text.
height	string	Widget height in pixels.
id	string	Unique widget UUID within the dashboard only.
icon	string	Icon to display.
input	string	Input type.
items	string	Input items (JSON).
label	string	Input label.
legend	object	Widget legend.
left	string	Fraction of viewport (0-1) or "rest".
limit	number	Item limit.
max	number	Maximum data value.
min	number	Minimum data value.
metric	string	CloudWatch Metric.
model	string	Database model.
multiple	boolean	Multiple selection.
namespace	string	Metric namespace.
options	object	Custom options.
pageSize	number	Table page size.
pivot	string	Table pivot column.
placeholder	string	Input placeholder.
prefix	string	Value prefix.
presentation	string	Presentation style.
range	object	Time range.
region	string	Region for metrics.
rows	number	Text area rows.
show	string	Show expression.
statistic	string	Math stat.
subtitle	string	Table subtitle.
suffix	string	Value suffix.
text	string	Static widget value.
ticks	number	Number of ticks.
timezone	string	Date input timezeon.
title	string	Widget title.
top	string	Top position.
type	string	Widget type.
units	string	Metric units.
url	string	Resource URL.
validate	string	RegExp validation.
width	string	Fraction of viewport (0-1).
z	number	Z order.

Actions

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

Range

Time range.

Field	Type
anchor	string
start	date
period	number
refresh	number
override	boolean
timezone	string

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	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
actions	array	Widget actions.
accept	string	File input accept type.
anchor	object	Anchor side.
axes	object	Graph axes.
cloudId	string	Cloud ID.
columns	array	Table columns to display.
css	array	CSS styles.
datetime	string	Date input datetime.
defaultValue	string	Default value.
dimensions	object	Metric and data dimensions.
field	string	Database data field.
fields	array	Database fields to fetch.
fixed	boolean	Lock down changes.
form	string	Input form name.
formField	string	Input form field.
footer	string	Widget footer.
format	string	Text and numeric format.
framed	boolean	Widget has a frame.
header	string	Widget header text.
height	string	Widget height in pixels.
id	string	Unique widget UUID within the dashboard only.
icon	string	Icon to display.
input	string	Input type.
items	string	Input items (JSON).
label	string	Input label.
legend	object	Widget legend.
left	string	Fraction of viewport (0-1) or "rest".
limit	number	Item limit.
max	number	Maximum data value.
min	number	Minimum data value.
metric	string	CloudWatch Metric.
model	string	Database model.
multiple	boolean	Multiple selection.
namespace	string	Metric namespace.
options	object	Custom options.
pageSize	number	Table page size.
pivot	string	Table pivot column.
placeholder	string	Input placeholder.
prefix	string	Value prefix.
presentation	string	Presentation style.
range	object	Time range.
region	string	Region for metrics.
rows	number	Text area rows.
show	string	Show expression.
statistic	string	Math stat.
subtitle	string	Table subtitle.
suffix	string	Value suffix.
text	string	Static widget value.
ticks	number	Number of ticks.
timezone	string	Date input timezeon.
title	string	Widget title.
top	string	Top position.
type	string	Widget type.
units	string	Metric units.
url	string	Resource URL.
validate	string	RegExp validation.
width	string	Fraction of viewport (0-1).
z	number	Z order.

Actions

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

Range

Time range.

Field	Type
anchor	string
start	date
period	number
refresh	number
override	boolean
timezone	string

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	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
actions	array	Widget actions.
accept	string	File input accept type.
anchor	object	Anchor side.
axes	object	Graph axes.
cloudId	string	Cloud ID.
columns	array	Table columns to display.
css	array	CSS styles.
datetime	string	Date input datetime.
defaultValue	string	Default value.
dimensions	object	Metric and data dimensions.
field	string	Database data field.
fields	array	Database fields to fetch.
fixed	boolean	Lock down changes.
form	string	Input form name.
formField	string	Input form field.
footer	string	Widget footer.
format	string	Text and numeric format.
framed	boolean	Widget has a frame.
header	string	Widget header text.
height	string	Widget height in pixels.
id	string	Unique widget UUID within the dashboard only.
icon	string	Icon to display.
input	string	Input type.
items	string	Input items (JSON).
label	string	Input label.
legend	object	Widget legend.
left	string	Fraction of viewport (0-1) or "rest".
limit	number	Item limit.
max	number	Maximum data value.
min	number	Minimum data value.
metric	string	CloudWatch Metric.
model	string	Database model.
multiple	boolean	Multiple selection.
namespace	string	Metric namespace.
options	object	Custom options.
pageSize	number	Table page size.
pivot	string	Table pivot column.
placeholder	string	Input placeholder.
prefix	string	Value prefix.
presentation	string	Presentation style.
range	object	Time range.
region	string	Region for metrics.
rows	number	Text area rows.
show	string	Show expression.
statistic	string	Math stat.
subtitle	string	Table subtitle.
suffix	string	Value suffix.
text	string	Static widget value.
ticks	number	Number of ticks.
timezone	string	Date input timezeon.
title	string	Widget title.
top	string	Top position.
type	string	Widget type.
units	string	Metric units.
url	string	Resource URL.
validate	string	RegExp validation.
width	string	Fraction of viewport (0-1).
z	number	Z order.

Actions

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

Range

Time range.

Field	Type
anchor	string
start	date
period	number
refresh	number
override	boolean
timezone	string

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			Widgets.
widgetCss	array

Widgets

Field	Type	Default	Notes
actions	array		Widget actions.
accept	string		File input accept type.
anchor	object	{}	Anchor side.
axes	object		Graph axes.
cloudId	string		Cloud ID.
columns	array		Table columns to display.
css	array		CSS styles.
datetime	string		Date input datetime.
defaultValue	string		Default value.
dimensions	object	{}	Metric and data dimensions.
field	string		Database data field.
fields	array		Database fields to fetch.
fixed	boolean		Lock down changes.
form	string		Input form name.
formField	string		Input form field.
footer	string		Widget footer.
format	string		Text and numeric format.
framed	boolean		Widget has a frame.
header	string		Widget header text.
height	string		Widget height in pixels.
id	string		Unique widget UUID within the dashboard only.
icon	string		Icon to display.
input	string		Input type.
items	string		Input items (JSON).
label	string		Input label.
legend	object		Widget legend.
left	string		Fraction of viewport (0-1) or "rest".
limit	number		Item limit.
max	number		Maximum data value.
min	number		Minimum data value.
metric	string		CloudWatch Metric.
model	string		Database model.
multiple	boolean		Multiple selection.
namespace	string		Metric namespace.
options	object		Custom options.
pageSize	number		Table page size.
pivot	string		Table pivot column.
placeholder	string		Input placeholder.
prefix	string		Value prefix.
presentation	string		Presentation style.
range	object	{}	Time range.
region	string		Region for metrics.
rows	number		Text area rows.
show	string		Show expression.
statistic	string		Math stat.
subtitle	string		Table subtitle.
suffix	string		Value suffix.
text	string		Static widget value.
ticks	number		Number of ticks.
timezone	string		Date input timezeon.
title	string		Widget title.
top	string		Top position.
type	string		Widget type.
units	string		Metric units.
url	string		Resource URL.
validate	string		RegExp validation.
width	string		Fraction of viewport (0-1).
z	number		Z order.

Actions

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

Range

Time range.

Field	Type	Default
anchor	string	relative
start	date
period	number	2419200
refresh	number	60
override	boolean	false
timezone	string	local

Query String Options

Field	Type	Default	Role	Notes
index	string		owner	Database index name: primary or gs1.
limit	number			Number of items to retrieve.
next	object			Pagination token for the next page.
prev	object			Pagination token for the previous page.

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	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
actions	array	Widget actions.
accept	string	File input accept type.
anchor	object	Anchor side.
axes	object	Graph axes.
cloudId	string	Cloud ID.
columns	array	Table columns to display.
css	array	CSS styles.
datetime	string	Date input datetime.
defaultValue	string	Default value.
dimensions	object	Metric and data dimensions.
field	string	Database data field.
fields	array	Database fields to fetch.
fixed	boolean	Lock down changes.
form	string	Input form name.
formField	string	Input form field.
footer	string	Widget footer.
format	string	Text and numeric format.
framed	boolean	Widget has a frame.
header	string	Widget header text.
height	string	Widget height in pixels.
id	string	Unique widget UUID within the dashboard only.
icon	string	Icon to display.
input	string	Input type.
items	string	Input items (JSON).
label	string	Input label.
legend	object	Widget legend.
left	string	Fraction of viewport (0-1) or "rest".
limit	number	Item limit.
max	number	Maximum data value.
min	number	Minimum data value.
metric	string	CloudWatch Metric.
model	string	Database model.
multiple	boolean	Multiple selection.
namespace	string	Metric namespace.
options	object	Custom options.
pageSize	number	Table page size.
pivot	string	Table pivot column.
placeholder	string	Input placeholder.
prefix	string	Value prefix.
presentation	string	Presentation style.
range	object	Time range.
region	string	Region for metrics.
rows	number	Text area rows.
show	string	Show expression.
statistic	string	Math stat.
subtitle	string	Table subtitle.
suffix	string	Value suffix.
text	string	Static widget value.
ticks	number	Number of ticks.
timezone	string	Date input timezeon.
title	string	Widget title.
top	string	Top position.
type	string	Widget type.
units	string	Metric units.
url	string	Resource URL.
validate	string	RegExp validation.
width	string	Fraction of viewport (0-1).
z	number	Z order.

Actions

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

Range

Time range.

Field	Type
anchor	string
start	date
period	number
refresh	number
override	boolean
timezone	string