Skip to content

Dashboard

Manage Builder UI Dashboards.


Create

Endpoint

1
POST /dashboard/create

Authorized User Role

1
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.
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
snap 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

1
POST /dashboard/find

Authorized User Role

1
user

Response

Field Type
accountId string
id string
layout string
name string
range object
responsive boolean
snap 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

1
POST /dashboard/get

Authorized User Role

1
user

Request Body

Field Type
id string

Response

Field Type
accountId string
id string
layout string
name string
range object
responsive boolean
snap 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

1
POST /dashboard/remove

Authorized User Role

1
user

Request Body

Field Type
id string

Update

Endpoint

1
POST /dashboard/update

Authorized User Role

1
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.
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
snap 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.