Skip to main content
Version: Next

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.

dashboard_titlestring

A title for the dashboard.

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.

owners object[]
  • Array [
    • first_namestring
    idinteger
    last_namestring
  • ]
    • 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
    roles object[]
  • Array [
    • idinteger
    namestring
  • ]
    • slugstring
    tags object[]
  • Array [
    • idinteger
    namestring
    type

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

  • ]
    • thumbnail_urlstringnullable
    urlstring
    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",
      "dashboard_title": "string",
      "id": 0,
      "is_managed_externally": true,
      "json_metadata": "string",
      "owners": [
        {
          "first_name": "string",
          "id": 0,
          "last_name": "string"
        }
      ],
      "position_json": "string",
      "published": true,
      "roles": [
        {
          "id": 0,
          "name": "string"
        }
      ],
      "slug": "string",
      "tags": [
        {
          "id": 0,
          "name": "string"
        }
      ],
      "thumbnail_url": "string",
      "url": "string"
    }