DashboardGroup

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/logicmonitor/main/json-schema/logicmonitor-dashboard-group-schema.json",
  "title": "DashboardGroup",
  "x-generated": "2026-10-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/logicmonitor-dashboard-groups-api-openapi.yml#/components/schemas/DashboardGroup",
  "type": "object",
  "required": [
    "name"
  ],
  "properties": {
    "template": {
      "description": "The template which is used for import dashboard group",
      "type": "object"
    },
    "fullPath": {
      "description": "The full path of the dashboard group",
      "readOnly": true,
      "type": "string"
    },
    "userPermission": {
      "description": "The permission of the user that made the API call",
      "readOnly": true,
      "type": "string"
    },
    "widgetTokens": {
      "description": "The tokens assigned at the group level",
      "type": "array",
      "items": {
        "$ref": "#/$defs/WidgetToken"
      }
    },
    "name": {
      "description": "The name of the dashboard group",
      "type": "string"
    },
    "numOfDirectSubGroups": {
      "format": "int64",
      "description": "The number of groups directly under the Dashboard Group",
      "readOnly": true,
      "type": "integer"
    },
    "numOfDashboards": {
      "format": "int64",
      "description": "The number of dashboards that belong to the Dashboard Group and any sub-groups",
      "readOnly": true,
      "type": "integer"
    },
    "description": {
      "description": "This is a description of the dashboard group",
      "type": "string"
    },
    "id": {
      "format": "int32",
      "description": "The Id of the dashboard group ",
      "readOnly": true,
      "type": "integer"
    },
    "dashboards": {
      "description": "The dashboards that belong to the group",
      "readOnly": true,
      "type": "array",
      "items": {
        "$ref": "#/$defs/DashboardData"
      }
    },
    "parentId": {
      "format": "int32",
      "description": "The Id of the parent dashboard group",
      "type": "integer"
    },
    "numOfDirectDashboards": {
      "format": "int64",
      "description": "The number of dashboards that belong directly to the Dashboard Group",
      "readOnly": true,
      "type": "integer"
    }
  },
  "$defs": {
    "DashboardData": {
      "type": "object",
      "properties": {
        "userPermission": {
          "readOnly": true,
          "type": "string"
        },
        "name": {
          "readOnly": true,
          "type": "string"
        },
        "sharable": {
          "readOnly": true,
          "type": "boolean"
        },
        "id": {
          "format": "int32",
          "readOnly": true,
          "type": "integer"
        }
      }
    },
    "WidgetToken": {
      "type": "object",
      "properties": {
        "inheritList": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/WidgetTokenInheritance"
          }
        },
        "name": {
          "description": "This is the name of the parent group of devices, if there is one established",
          "type": "string"
        },
        "type": {
          "readOnly": true,
          "type": "string"
        },
        "value": {
          "description": "this is the name of the child group of devices, if there is one",
          "type": "string"
        }
      }
    },
    "WidgetTokenInheritance": {
      "type": "object",
      "properties": {
        "fullpath": {
          "readOnly": true,
          "type": "string"
        },
        "value": {
          "readOnly": true,
          "type": "string"
        }
      }
    }
  }
}