Dashboard

Manage Builder UI Dashboards.

---

Create

Endpoint

POST /dashboard/create

Authorized User Role

user

Request Body

Field	Type	Required	Default
name	string	yes
range	object
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.
height	string	Pixel height.
id	string	Unique widget UUID.
left	string	Left position (x coord).
limit	number	Items limit.
metric	string	CloudWatch Metric.
model	string	Database model name.
name	string	Widget unique name. Used for the title.
namespace	string	Metric namespace.
statistic	string	Math statistic.
top	string	Top position (y coord).
type	string	Widget type.
units	string	Metric units.
width	string	Widget width in pixels.
z	string	Z order.

Response

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

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.
height	string	Pixel height.
id	string	Unique widget UUID.
left	string	Left position (x coord).
limit	number	Items limit.
metric	string	CloudWatch Metric.
model	string	Database model name.
name	string	Widget unique name. Used for the title.
namespace	string	Metric namespace.
statistic	string	Math statistic.
top	string	Top position (y coord).
type	string	Widget type.
units	string	Metric units.
width	string	Widget width in pixels.
z	string	Z order.

---

Find

Endpoint

POST /dashboard/find

Authorized User Role

user

Response

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

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.
height	string	Pixel height.
id	string	Unique widget UUID.
left	string	Left position (x coord).
limit	number	Items limit.
metric	string	CloudWatch Metric.
model	string	Database model name.
name	string	Widget unique name. Used for the title.
namespace	string	Metric namespace.
statistic	string	Math statistic.
top	string	Top position (y coord).
type	string	Widget type.
units	string	Metric units.
width	string	Widget width in pixels.
z	string	Z order.

---

Get

Endpoint

POST /dashboard/get

Authorized User Role

user

Request Body

Field	Type
id	string

Response

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

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.
height	string	Pixel height.
id	string	Unique widget UUID.
left	string	Left position (x coord).
limit	number	Items limit.
metric	string	CloudWatch Metric.
model	string	Database model name.
name	string	Widget unique name. Used for the title.
namespace	string	Metric namespace.
statistic	string	Math statistic.
top	string	Top position (y coord).
type	string	Widget type.
units	string	Metric units.
width	string	Widget width in pixels.
z	string	Z order.

---

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
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.
height	string	Pixel height.
id	string	Unique widget UUID.
left	string	Left position (x coord).
limit	number	Items limit.
metric	string	CloudWatch Metric.
model	string	Database model name.
name	string	Widget unique name. Used for the title.
namespace	string	Metric namespace.
statistic	string	Math statistic.
top	string	Top position (y coord).
type	string	Widget type.
units	string	Metric units.
width	string	Widget width in pixels.
z	string	Z order.

Response

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

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.
height	string	Pixel height.
id	string	Unique widget UUID.
left	string	Left position (x coord).
limit	number	Items limit.
metric	string	CloudWatch Metric.
model	string	Database model name.
name	string	Widget unique name. Used for the title.
namespace	string	Metric namespace.
statistic	string	Math statistic.
top	string	Top position (y coord).
type	string	Widget type.
units	string	Metric units.
width	string	Widget width in pixels.
z	string	Z order.