DashboardRestApi.put

certification_detailsstringnullable

Details of the certification

certified_bystringnullable

Person or group that has certified this dashboard

cssstringnullable

Override CSS for the dashboard.

dashboard_titlestringnullable

A title for the dashboard.

Possible values: <= 500 characters

descriptionstringnullable

A description for the dashboard.

editors object[]

Array [

oneOf

• integer
• object

Subject ID, not a user ID.

integer

Subject ID, not a user ID.

]

external_urlstringnullable

is_managed_externallybooleannullable

json_metadatastringnullable

This JSON object is generated dynamically when clicking the save or overwrite button in the dashboard view. It is exposed here for reference and for power users who may want to alter specific parameters.

position_jsonstringnullable

This json object describes the positioning of the widgets in the dashboard. It is dynamically generated when adjusting the widgets size and positions by using drag & drop in the dashboard view

publishedbooleannullable

Determines whether or not this dashboard is visible in the list of all dashboards.

slugstringnullable

Unique identifying part for the web address of the dashboard.

Possible values: <= 255 characters

tagsinteger[]

theme_idintegernullable

Theme ID for the dashboard

uuidstring<uuid>nullable

viewers object[]

Array [

oneOf

• integer
• object

Subject ID, not a user ID.

integer

Subject ID, not a user ID.

]

DashboardRestApi.put

{
  "certification_details": "string",
  "certified_by": "string",
  "css": "string",
  "dashboard_title": "string",
  "description": "string",
  "editors": [
    0,
    {
      "id": 0,
      "type": "user"
    }
  ],
  "external_url": "string",
  "is_managed_externally": true,
  "json_metadata": "string",
  "position_json": "string",
  "published": true,
  "slug": "string",
  "tags": [
    0
  ],
  "theme_id": 0,
  "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "viewers": [
    0,
    {
      "id": 0,
      "type": "user"
    }
  ]
}