Dashboard

Full dashboard representation with components and data

CloudCRMCustomer ManagementEnterpriseSales

Properties

Name	Type	Description
id	string
name	string
description	string
folderId	string
folderName	string
runningUser	object
components	array

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Dashboard",
  "title": "Dashboard",
  "type": "object",
  "description": "Full dashboard representation with components and data",
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "description": {
      "type": "string",
      "nullable": true
    },
    "folderId": {
      "type": "string"
    },
    "folderName": {
      "type": "string"
    },
    "runningUser": {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string"
        },
        "id": {
          "type": "string"
        }
      }
    },
    "components": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "componentData": {
            "type": "object"
          },
          "footer": {
            "type": "string",
            "nullable": true
          },
          "header": {
            "type": "string",
            "nullable": true
          },
          "id": {
            "type": "string"
          },
          "reportId": {
            "type": "string"
          },
          "type": {
            "type": "string"
          }
        }
      }
    }
  }
}