Skip to main content

DashboardCreate

Payload used to create Dashboard. The required field is name.

nameName (string)required
alias object
anyOf
string
collection_id object

Identifier of the containing collection.

anyOf
string

Possible values: non-empty

folder_id object
anyOf
string
tags object
anyOf
  • Array [
  • string
  • ]
  • description object
    anyOf
    string
    widgets object[]

    Dashboard widgets

  • Array [
  • config objectrequired
    property name*any
    layout objectrequired
    property name*any
  • ]
  • shared object

    Whether the dashboard is shared

    anyOf
    boolean
    refresh_interval object

    Viewer auto-refresh interval in seconds. Set to 0 or null to disable auto-refresh.

    anyOf
    integer
    DashboardCreate
    {
    "name": "string",
    "alias": "string",
    "collection_id": "string",
    "folder_id": "string",
    "tags": [
    "string"
    ],
    "description": "string",
    "widgets": [
    {
    "config": {},
    "layout": {}
    }
    ],
    "shared": true,
    "refresh_interval": 0
    }