Dashboard

Manage Builder UI Dashboards.

Create

Create a dashboard.

Endpoint

POST /dashboard/create

Authorized User Role

user

Request Body

Field	Type	Required	Default	Notes
css	array			CSS styles.
emulate	string			Emulate.
fixed	boolean			Fixed.
framed	boolean			Framed.
layout	string			Layout.
live	boolean			Live.
name	string	yes		Name.
range	object			Range.
refresh	number			Refresh.
toolbar	boolean			Toolbar.
type	string			Type.
widgets	array		[]	Widgets.
widgetCss	array			Widget CSS.

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	Notes
index	string		Index name: primary or gs1.
limit	number		Limit number of results.
next	object		Token for next page.
prev	object		Token for previous page.

Response

Dashboard Record.

Field	Type	Notes
accountId	string	Owning account ID.
css	array	CSS styles.
emulate	string	Emulate device.
fixed	boolean	Prevent runtime changes.
framed	boolean	Dashboard has a frame.
id	string	Dashboard ID.
layout	string	Dashboard layout.
live	boolean	Dashboard should update data in real time.
name	string	Dashboard name.
range	object	Dashboard time range.
refresh	number	Dashboard refresh rate (seconds).
toolbar	boolean	Dashboard has a toolbar for widget actions.
type	string	Dashboard type: "page" or "dashboard".
widgetCss	array	Widget CSS styles.
widgets	array	Widgets.

Range

Dashboard time range.

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

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 matching dashboards.

Endpoint

POST /dashboard/find

Authorized User Role

user

Request Body

Field	Type	Notes
name	string	Dashboard name.

Query String Options

Field	Type	Default	Notes
index	string		Index name: primary or gs1.
limit	number		Limit number of results.
next	object		Token for next page.
prev	object		Token for previous page.

Response

Paged response.

Field	Type	Notes
data	array	An array of Dashboard records.
next	string	Paged cursor to use for the next page of items.
prev	string	Pages cursor to use for the previous page of items.

Dashboard

Field	Type	Notes
accountId	string	Owning account ID.
css	array	CSS styles.
emulate	string	Emulate device.
fixed	boolean	Prevent runtime changes.
framed	boolean	Dashboard has a frame.
id	string	Dashboard ID.
layout	string	Dashboard layout.
live	boolean	Dashboard should update data in real time.
name	string	Dashboard name.
range	object	Dashboard time range.
refresh	number	Dashboard refresh rate (seconds).
toolbar	boolean	Dashboard has a toolbar for widget actions.
type	string	Dashboard type: "page" or "dashboard".
widgetCss	array	Widget CSS styles.
widgets	array	Widgets.

Range

Dashboard time range.

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

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 dashboard by ID or name.

Endpoint

POST /dashboard/get

Authorized User Role

user

Request Body

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

Response

Dashboard Record.

Field	Type	Notes
accountId	string	Owning account ID.
css	array	CSS styles.
emulate	string	Emulate device.
fixed	boolean	Prevent runtime changes.
framed	boolean	Dashboard has a frame.
id	string	Dashboard ID.
layout	string	Dashboard layout.
live	boolean	Dashboard should update data in real time.
name	string	Dashboard name.
range	object	Dashboard time range.
refresh	number	Dashboard refresh rate (seconds).
toolbar	boolean	Dashboard has a toolbar for widget actions.
type	string	Dashboard type: "page" or "dashboard".
widgetCss	array	Widget CSS styles.
widgets	array	Widgets.

Range

Dashboard time range.

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

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 by ID.

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	Notes
accountId	string		Account ID.
css	array		CSS styles.
emulate	object		Emulate.
fixed	boolean		Fixed.
framed	boolean		Framed.
id	string	yes	Dashboard ID.
layout	string		Layout.
live	boolean		Live.
name	string	yes	Dashboard name.
range	object		Range.
refresh	number		Refresh.
toolbar	boolean		Toolbar.
type	string		Type: "page" or "dashboard".
widgets	array		Widgets.
widgetCss	array		Widget CSS.

Query String Options

Field	Type	Default	Notes
index	string		Index name: primary or gs1.
limit	number		Limit number of results.
next	object		Token for next page.
prev	object		Token for previous page.

Response

Dashboard Record.

Field	Type	Notes
accountId	string	Owning account ID.
css	array	CSS styles.
emulate	string	Emulate device.
fixed	boolean	Prevent runtime changes.
framed	boolean	Dashboard has a frame.
id	string	Dashboard ID.
layout	string	Dashboard layout.
live	boolean	Dashboard should update data in real time.
name	string	Dashboard name.
range	object	Dashboard time range.
refresh	number	Dashboard refresh rate (seconds).
toolbar	boolean	Dashboard has a toolbar for widget actions.
type	string	Dashboard type: "page" or "dashboard".
widgetCss	array	Widget CSS styles.
widgets	array	Widgets.

Range

Dashboard time range.

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

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