Dashboard

Manage UI Dashboards.

---

Create

Endpoint

POST /dashboard/create

Authorized User Role

user

Request Body

Field	Type	Required	Default
name	string	yes
range	object
snap	boolean
widgets	array		[]

Widget

An array of Widgets items.

Field	Type	Notes
dashboard	string	Target dashboard to select.
dimensions	object	Metric and data dimensions.
field	string	Database model field.
fields	array	Database table fields.
height	string	Pixel height.
id	string	Unique widget UUID.
left	string	Left position (x coord).
limit	number	Items limit.
link	string
metric	string	CloudWatch Metric.
model	string	Database model name.
override	boolean
name	string
namespace	string	Metric namespace.
params	string
statistic	string	Math statistic.
title	string	Widget title.
top	string	Top position (y coord).
trigger	string
type	string	Widget type.
units	string	Metric units.
width	string	Widget width in pixels.
z	string	Z order.
range	object
css	object
format	string
header	string
footer	string
max	number
min	number
prefix	string
suffix	string
text	string

Range

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

Response

Field	Type
accountId	string
id	string
layout	string
name	string
range	object
snap	boolean
widgets	array

Range

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

Widgets

An array of Widgets items.

Field	Type	Notes
dashboard	string	Target dashboard to select.
dimensions	object	Metric and data dimensions.
field	string	Database model field.
fields	array	Database table fields.
height	string	Pixel height.
id	string	Unique widget UUID.
left	string	Left position (x coord).
limit	number	Items limit.
link	string
metric	string	CloudWatch Metric.
model	string	Database model name.
override	boolean
name	string
namespace	string	Metric namespace.
params	string
statistic	string	Math statistic.
title	string	Widget title.
top	string	Top position (y coord).
trigger	string
type	string	Widget type.
units	string	Metric units.
width	string	Widget width in pixels.
z	string	Z order.
range	object
css	object
format	string
header	string
footer	string
max	number
min	number
prefix	string
suffix	string
text	string

Range

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

---

Find

Endpoint

POST /dashboard/find

Authorized User Role

user

Response

Field	Type
accountId	string
id	string
layout	string
name	string
range	object
snap	boolean
widgets	array

Range

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

Widgets

An array of Widgets items.

Field	Type	Notes
dashboard	string	Target dashboard to select.
dimensions	object	Metric and data dimensions.
field	string	Database model field.
fields	array	Database table fields.
height	string	Pixel height.
id	string	Unique widget UUID.
left	string	Left position (x coord).
limit	number	Items limit.
link	string
metric	string	CloudWatch Metric.
model	string	Database model name.
override	boolean
name	string
namespace	string	Metric namespace.
params	string
statistic	string	Math statistic.
title	string	Widget title.
top	string	Top position (y coord).
trigger	string
type	string	Widget type.
units	string	Metric units.
width	string	Widget width in pixels.
z	string	Z order.
range	object
css	object
format	string
header	string
footer	string
max	number
min	number
prefix	string
suffix	string
text	string

Range

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

---

Get

Endpoint

POST /dashboard/get

Authorized User Role

user

Request Body

Field	Type
id	string
name	string

Response

Field	Type
accountId	string
id	string
layout	string
name	string
range	object
snap	boolean
widgets	array

Range

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

Widgets

An array of Widgets items.

Field	Type	Notes
dashboard	string	Target dashboard to select.
dimensions	object	Metric and data dimensions.
field	string	Database model field.
fields	array	Database table fields.
height	string	Pixel height.
id	string	Unique widget UUID.
left	string	Left position (x coord).
limit	number	Items limit.
link	string
metric	string	CloudWatch Metric.
model	string	Database model name.
override	boolean
name	string
namespace	string	Metric namespace.
params	string
statistic	string	Math statistic.
title	string	Widget title.
top	string	Top position (y coord).
trigger	string
type	string	Widget type.
units	string	Metric units.
width	string	Widget width in pixels.
z	string	Z order.
range	object
css	object
format	string
header	string
footer	string
max	number
min	number
prefix	string
suffix	string
text	string

Range

Field	Type
anchor	string
start	date
period	number
refresh	number
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
id	string
layout	string
name	string	yes
range	object
responsive	boolean
snap	boolean
widgets	array		[]

Widget

An array of Widgets items.

Field	Type	Notes
dashboard	string	Target dashboard to select.
dimensions	object	Metric and data dimensions.
field	string	Database model field.
fields	array	Database table fields.
height	string	Pixel height.
id	string	Unique widget UUID.
left	string	Left position (x coord).
limit	number	Items limit.
link	string
metric	string	CloudWatch Metric.
model	string	Database model name.
override	boolean
name	string
namespace	string	Metric namespace.
params	string
statistic	string	Math statistic.
title	string	Widget title.
top	string	Top position (y coord).
trigger	string
type	string	Widget type.
units	string	Metric units.
width	string	Widget width in pixels.
z	string	Z order.
range	object
css	object
format	string
header	string
footer	string
max	number
min	number
prefix	string
suffix	string
text	string

Range

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

Response

Field	Type
accountId	string
id	string
layout	string
name	string
range	object
snap	boolean
widgets	array

Range

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

Widgets

An array of Widgets items.

Field	Type	Notes
dashboard	string	Target dashboard to select.
dimensions	object	Metric and data dimensions.
field	string	Database model field.
fields	array	Database table fields.
height	string	Pixel height.
id	string	Unique widget UUID.
left	string	Left position (x coord).
limit	number	Items limit.
link	string
metric	string	CloudWatch Metric.
model	string	Database model name.
override	boolean
name	string
namespace	string	Metric namespace.
params	string
statistic	string	Math statistic.
title	string	Widget title.
top	string	Top position (y coord).
trigger	string
type	string	Widget type.
units	string	Metric units.
width	string	Widget width in pixels.
z	string	Z order.
range	object
css	object
format	string
header	string
footer	string
max	number
min	number
prefix	string
suffix	string
text	string

Range

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