Sign in
latestOpenAPI 3.0.32026-08-19299284712.8 KB

67d9f45bb99b

Dashboard

Create a dashboard

Create a dashboard

post/dashboard

Headers

X-Company-IDstring required

Associates request with company

Request body

idstring uuid required
namestring required
descriptionstring nullable
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 required
publish_status'DRAFT' | 'PUBLISHED' required
  • DRAFT - Draft
  • PUBLISHED - Published
sharing_scheme'ALL' | 'ADMINS' | 'SPECIFIC' required
  • ALL - All Team Members
  • ADMINS - Only Admins
  • SPECIFIC - Specific Team Members
{"stackTrail":"components:schemas:CreateDashboard:properties:sharing_users","oasType":"schema","type":"unknown"}

Response

idstring uuid required
namestring required
descriptionstring nullable
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 required
publish_status'DRAFT' | 'PUBLISHED' required
  • DRAFT - Draft
  • PUBLISHED - Published
sharing_scheme'ALL' | 'ADMINS' | 'SPECIFIC' required
  • ALL - All Team Members
  • ADMINS - Only Admins
  • SPECIFIC - Specific Team Members
{"stackTrail":"components:schemas:CreateDashboard:properties:sharing_users","oasType":"schema","type":"unknown"}