REST API Developer's Guide

About the Dashboards Resource

The device resource allows you to programmatically manage your LogicMonitor dashboards.

As with all of our API calls, authentication is required.

 

Resource URI:

/dashboard/dashboards

 

Resource Properties

All dashboards have the following properties:

Property

Description

Type

id The Id of the dashboard Integer
groupId The id of the group the dashboard belongs to Integer
name The name of the dashboard String
description The description of the dashboard String
sharable Whether or not the dashboard is sharable. This value will always be true unless the dashboard is a private dashboard. Boolean
owner This field will be empty unless the dashboard is a private dashboard, in which case the owner will be listed String
widgetsOrder Information about widget display order used by the UI JSON Object
widgetsConfig Information about widget configuration used by the UI JSON Object
userPermission The permission of the user that made the API call String
groupFullPatch The full path (excluding root group) of the group the dashboard belongs to String
groupName The name of the group the dashboard belongs to String
useDynamicWidget Whether or not this will be a dashboard that uses dashboard tokens Boolean
widgetTokens If useDynamicWidget=true, this field must at least contain tokens defaultDeviceGroup and defaultServiceGroup, e.g. "widgetTokens":[{"name":"defaultDeviceGroup","value":"*"},{"name":"defaultServiceGroup","value":"*"}] JSON Object