Skip to main content
Version: Next

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

    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. 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_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

    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"
        }
      ]
    }