CUcubesoftware
Dashboard

Update a dashboard by ID

Update writable dashboard fields

patch/dashboard/{id}

Request

  • Base URL
    https://api.cubesoftware.com
  • Auth
    OAuth 2
    Authorization code: https://portal.cubesoftware.com/o/authorize/
    Token URL: https://api.cubesoftware.com/o/token/

Path parameters

idstring required

Headers

X-Company-IDstring required

Associates request with company

Request body

idstring uuid
namestring
created_atstring date-time
external_idstring nullable
source'METABASE'
  • METABASE - Metabase
edit_urlstring nullable

Returns a url in the third party system for editing the dashboard.

Returns: str url in the external system where one can edit the dashboard.

externalobject nullable

Returns an up to date representation of the dashboard provided by the external system.

Returns: A dictionary representation of the dashboard in the external system or None if this dashboard is not a metabase dashboard.

Raises: MBNotFoundError: raised if the dashboard is not found in the external system.

defaultboolean
publish_status'DRAFT' | 'PUBLISHED'
  • DRAFT - Draft
  • PUBLISHED - Published
sharing_scheme'ALL' | 'ADMINS' | 'SPECIFIC'
  • ALL - All Team Members
  • ADMINS - Only Admins
  • SPECIFIC - Specific Team Members
sharing_usersunknown

Response

idstring uuid required
namestring required
created_atstring date-time required
external_idstring nullable required
source'METABASE' required
  • METABASE - Metabase
edit_urlstring nullable required

Returns a url in the third party system for editing the dashboard.

Returns: str url in the external system where one can edit the dashboard.

externalobject nullable required

Returns an up to date representation of the dashboard provided by the external system.

Returns: A dictionary representation of the dashboard in the external system or None if this dashboard is not a metabase dashboard.

Raises: MBNotFoundError: raised if the dashboard is not found in the external system.

defaultboolean
publish_status'DRAFT' | 'PUBLISHED'
  • DRAFT - Draft
  • PUBLISHED - Published
sharing_scheme'ALL' | 'ADMINS' | 'SPECIFIC'
  • ALL - All Team Members
  • ADMINS - Only Admins
  • SPECIFIC - Specific Team Members
sharing_usersunknown required

Changes

No operation changes recorded.