Dashboards API

About the Dashboards API

CloudWisdom’s Dashboards API can be used to get a list of dashboards, create new ones, edit their settings, and remove them from CloudWisdom. You can test these endpoints by visiting our Swagger page and by clicking the interactive buttons below.

GET from /dashboards

Use this endpoint to get a list of all dashboards. Does not include widgets.

View Method Details.

POST to /dashboards

Use this endpoint to create a dashboard.

View Method Details.

GET from /dashboards/dashboardtype/{type}

Use this endpoint to get dashboards specific to a certain element type.

View Method Details.

GET from /dashboards/elementtype

Use this endpoint to get a list of all element detail dashboards. Does not include widgets.

View Method Details.

DELETE to /dashboards/{id}

Use this endpoint to delete a dashboard.

View Method Details.

GET from /dashboards/{id}

Use this endpoint to get a dashboard.

View Method Details.

PUT to /dashboards/{id}

Use this endpoint to update a dashboard’s settings.

View Method Details.

POST to /dashboards/{id}/copy

Use this endpoint to copy a dashboard.

View Method Details.

Understanding gridstackContents

gridstackContents is a dashboard property that defines the layout of its widgets. It requires widget IDs as well as definitions for width and height.

View More.

Create a New Dashboard Based on an Existing Dashboard

There are two ways to build a dashboard: copy an existing dashboard (POST) and make an update to it (PUT), or retrieve an existing dashboard (GET) and use it as a starting point to create a new one (POST). This example uses the GET and POST endpoints.

View More.