Support Center Home


About the Dashboards Resource

Overview

The dashboards resource allows you to programmatically manage your LogicMonitor dashboards. As with all of our API calls, authentication is required.

Using LogicMonitor’s REST API you can:

Resource Information

URI: /dashboard/dashboards

Resource Properties: All dashboards have the following properties.

Property Description Type
idThe Id of the dashboardInteger
groupIdThe id of the group the dashboard belongs toInteger
nameThe name of the dashboardString
descriptionThe description of the dashboardString
sharableWhether or not the dashboard is sharable. This value will always be true unless the dashboard is a private dashboard. Boolean
ownerThis field will be empty unless the dashboard is a private dashboard, in which case the owner will be listedString
widgetsOrderInformation about widget display order used by the UIJSON Object
widgetsConfigInformation about widget configuration used by the UIJSON Object
userPermissionThe permission of the user that made the API callString
groupFullPatchThe full path (excluding root group) of the group the dashboard belongs toString
groupNameThe name of the group the dashboard belongs toString
useDynamicWidgetWhether or not this will be a dashboard that uses dashboard tokensBoolean
widgetTokensIf useDynamicWidget=true, this field must at least contain tokens defaultDeviceGroup and defaultServiceGroup, e.g. “widgetTokens”:[{“name”:”defaultDeviceGroup”,”value”:”*”},{“name”:”defaultServiceGroup”,”value”:”*”}]JSON Object

In This Article