Dashboard

Manage UI Dashboards.

Create

Endpoint

POST /dashboard/create

Authorized User Role

user

Request Body

Field	Type	Required	Default
css	array
design	boolean
emulate	string
dashboard	boolean
fixed	boolean
framed	boolean
full	boolean
live	boolean
name	string	yes
options	object
range	object
refresh	number
snap	boolean
toolbar	boolean
type	string
widgets	array		[]
widgetCss	array

Widget

An array of Widgets items.

Field	Type	Notes
action	object
accept	string	File input accept type.
anchor	object
axes	object	Graph axes.
css	array
dashboard	string	Target dashboard to select.
dimensions	object	Metric and data dimensions.
field	string	Database model field.
fields	array	Database table fields.
fixed	boolean
form	string
footer	string
format	string
framed	boolean
header	string
height	string	Pixel height.
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.
namespace	string	Metric namespace.
options	object	Custom options.
pivot	string	Table pivot column.
placeholder	string	Input placeholder.
prefix	string
range	object
rows	number	Number of rows in textarea input.
show	string
statistic	string	Math statistic.
subtitle	string
suffix	string
text	string	Static widget value.
ticks	number	Number of axis ticks on x axis.
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

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

Range

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

Response

Field	Type
accountId	string
css	array
design	boolean
emulate	string
fixed	boolean
framed	boolean
full	boolean
id	string
layout	string
live	boolean
name	string
range	object
refresh	number
snap	boolean
toolbar	boolean
widgetCss	array
widgets	array

Range

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

Widgets

An array of Widgets items.

Field	Type	Notes
action	object
accept	string	File input accept type.
anchor	object
axes	object	Graph axes.
css	array
dashboard	string	Target dashboard to select.
dimensions	object	Metric and data dimensions.
field	string	Database model field.
fields	array	Database table fields.
fixed	boolean
form	string
footer	string
format	string
framed	boolean
header	string
height	string	Pixel height.
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.
namespace	string	Metric namespace.
options	object	Custom options.
pivot	string	Table pivot column.
placeholder	string	Input placeholder.
prefix	string
range	object
rows	number	Number of rows in textarea input.
show	string
statistic	string	Math statistic.
subtitle	string
suffix	string
text	string	Static widget value.
ticks	number	Number of axis ticks on x axis.
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

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

Range

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

Find

Endpoint

POST /dashboard/find

Authorized User Role

user

Response

Field	Type
accountId	string
css	array
design	boolean
emulate	string
fixed	boolean
framed	boolean
full	boolean
id	string
layout	string
live	boolean
name	string
range	object
refresh	number
snap	boolean
toolbar	boolean
widgetCss	array
widgets	array

Range

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

Widgets

An array of Widgets items.

Field	Type	Notes
action	object
accept	string	File input accept type.
anchor	object
axes	object	Graph axes.
css	array
dashboard	string	Target dashboard to select.
dimensions	object	Metric and data dimensions.
field	string	Database model field.
fields	array	Database table fields.
fixed	boolean
form	string
footer	string
format	string
framed	boolean
header	string
height	string	Pixel height.
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.
namespace	string	Metric namespace.
options	object	Custom options.
pivot	string	Table pivot column.
placeholder	string	Input placeholder.
prefix	string
range	object
rows	number	Number of rows in textarea input.
show	string
statistic	string	Math statistic.
subtitle	string
suffix	string
text	string	Static widget value.
ticks	number	Number of axis ticks on x axis.
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

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

Range

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

Get

Endpoint

POST /dashboard/get

Authorized User Role

user

Request Body

Field	Type
id	string
name	string

Response

Field	Type
accountId	string
css	array
design	boolean
emulate	string
fixed	boolean
framed	boolean
full	boolean
id	string
layout	string
live	boolean
name	string
range	object
refresh	number
snap	boolean
toolbar	boolean
widgetCss	array
widgets	array

Range

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

Widgets

An array of Widgets items.

Field	Type	Notes
action	object
accept	string	File input accept type.
anchor	object
axes	object	Graph axes.
css	array
dashboard	string	Target dashboard to select.
dimensions	object	Metric and data dimensions.
field	string	Database model field.
fields	array	Database table fields.
fixed	boolean
form	string
footer	string
format	string
framed	boolean
header	string
height	string	Pixel height.
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.
namespace	string	Metric namespace.
options	object	Custom options.
pivot	string	Table pivot column.
placeholder	string	Input placeholder.
prefix	string
range	object
rows	number	Number of rows in textarea input.
show	string
statistic	string	Math statistic.
subtitle	string
suffix	string
text	string	Static widget value.
ticks	number	Number of axis ticks on x axis.
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

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

Range

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

Remove

Endpoint

POST /dashboard/remove

Authorized User Role

user

Request Body

Field	Type
id	string

Update

Endpoint

POST /dashboard/update

Authorized User Role

user

Request Body

Field	Type	Required	Default
css	array
design	boolean
emulate	string
fixed	boolean
framed	boolean
full	boolean
id	string
layout	string
live	boolean
name	string	yes
options	object
range	object
refresh	number
snap	boolean
toolbar	boolean
type	string
widgets	array		[]
widgetCss	array

Widget

An array of Widgets items.

Field	Type	Notes
action	object
accept	string	File input accept type.
anchor	object
axes	object	Graph axes.
css	array
dashboard	string	Target dashboard to select.
dimensions	object	Metric and data dimensions.
field	string	Database model field.
fields	array	Database table fields.
fixed	boolean
form	string
footer	string
format	string
framed	boolean
header	string
height	string	Pixel height.
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.
namespace	string	Metric namespace.
options	object	Custom options.
pivot	string	Table pivot column.
placeholder	string	Input placeholder.
prefix	string
range	object
rows	number	Number of rows in textarea input.
show	string
statistic	string	Math statistic.
subtitle	string
suffix	string
text	string	Static widget value.
ticks	number	Number of axis ticks on x axis.
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

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

Range

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

Response

Field	Type
accountId	string
css	array
design	boolean
emulate	string
fixed	boolean
framed	boolean
full	boolean
id	string
layout	string
live	boolean
name	string
range	object
refresh	number
snap	boolean
toolbar	boolean
widgetCss	array
widgets	array

Range

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

Widgets

An array of Widgets items.

Field	Type	Notes
action	object
accept	string	File input accept type.
anchor	object
axes	object	Graph axes.
css	array
dashboard	string	Target dashboard to select.
dimensions	object	Metric and data dimensions.
field	string	Database model field.
fields	array	Database table fields.
fixed	boolean
form	string
footer	string
format	string
framed	boolean
header	string
height	string	Pixel height.
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.
namespace	string	Metric namespace.
options	object	Custom options.
pivot	string	Table pivot column.
placeholder	string	Input placeholder.
prefix	string
range	object
rows	number	Number of rows in textarea input.
show	string
statistic	string	Math statistic.
subtitle	string
suffix	string
text	string	Static widget value.
ticks	number	Number of axis ticks on x axis.
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

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

Range

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