DashboardGetResponseSchema

certification_detailsstring

Details of the certification

certified_bystring

Person or group that has certified this dashboard

changed_by object

first_namestring

idinteger

last_namestring

changed_by_namestring

changed_onstring<date-time>

changed_on_delta_humanizedstring

chartsstring[]

created_by object

first_namestring

idinteger

last_namestring

created_on_delta_humanizedstring

cssstring

Override CSS for the dashboard.

custom_tags object[]

Array [

idinteger

namestring

typestring

Possible values: [1, 2, 3, 4]

]

dashboard_titlestring

A title for the dashboard.

descriptionstringnullable

editors object[]

Array [

idinteger

imgstring

labelstring

secondary_labelstring

typeinteger

]

idinteger

is_managed_externallybooleannullable

json_metadatastring

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. When AUTO_REFRESH_POLICY is enabled, the optional auto_refresh_policy key holds the dashboard's auto-refresh policy: auto_refresh_allowed (boolean, default true), minimum_refresh_interval and maximum_refresh_interval (each null or {"value": <whole number >= 1>, "unit": "seconds" | "minutes" | "hours"}; the length must be one of the standard refresh intervals, no other upper limit). With a policy, refresh_frequency must be 0 or a whole number of seconds that is a standard interval within the bounds, and 0 when auto-refresh isn't allowed. On create, a missing or null auto_refresh_policy means no policy. An update or copy that omits auto_refresh_policy keeps the stored policy; send null to remove it.

position_jsonstring

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

publishedboolean

slugstring

tags object[]

Array [

idinteger

namestring

typestring

Possible values: [1, 2, 3, 4]

]

theme objectnullable

idinteger

json_datastring

theme_namestring

thumbnail_urlstringnullable

urlstring

uuidstring<uuid>nullable

viewers object[]

Array [

idinteger

imgstring

labelstring

secondary_labelstring

typeinteger

]

DashboardGetResponseSchema

{
  "certification_details": "string",
  "certified_by": "string",
  "changed_by": {
    "first_name": "string",
    "id": 0,
    "last_name": "string"
  },
  "changed_by_name": "string",
  "changed_on": "2024-07-29T15:51:28.071Z",
  "changed_on_delta_humanized": "string",
  "charts": [
    "string"
  ],
  "created_by": {
    "first_name": "string",
    "id": 0,
    "last_name": "string"
  },
  "created_on_delta_humanized": "string",
  "css": "string",
  "custom_tags": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "dashboard_title": "string",
  "description": "string",
  "editors": [
    {
      "id": 0,
      "img": "string",
      "label": "string",
      "secondary_label": "string",
      "type": 0
    }
  ],
  "id": 0,
  "is_managed_externally": true,
  "json_metadata": "string",
  "position_json": "string",
  "published": true,
  "slug": "string",
  "tags": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "theme": {
    "id": 0,
    "json_data": "string",
    "theme_name": "string"
  },
  "thumbnail_url": "string",
  "url": "string",
  "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "viewers": [
    {
      "id": 0,
      "img": "string",
      "label": "string",
      "secondary_label": "string",
      "type": 0
    }
  ]
}