Dashboards

Create or update a dashboard

Create a new dashboard, if it does not exist or update an existing dashboard.

put/v1/dashboards

Request

  • Base URL: https://demo.getcollate.io/api
  • URL: https://demo.getcollate.io/api/v1/dashboards
  • Auth: HTTP bearer

Request body

namestring required
displayNamestring
descriptionstring
dashboardType'Dashboard' | 'Report'
sourceUrlstring
projectstring
chartsstring[]
dataModelsstring[]
servicestring required
extensionobject
domainsstring[]
dataProductsstring[]
sourceHashstring

Response

The dashboard

idstring uuid required
namestring required
displayNamestring
fullyQualifiedNamestring
descriptionstring
projectstring
versionnumber double
updatedAtinteger
updatedBystring
impersonatedBystring
dashboardType'Dashboard' | 'Report'
sourceUrlstring
hrefstring uri
serviceType'Superset' | 'Looker' | 'Tableau' | 'Redash' | 'Metabase' | 'PowerBI' | 'PowerBIReportServer' | 'Mode' | 'CustomDashboard' | 'DomoDashboard' | 'QuickSight' | 'QlikSense' | 'Lightdash' | 'MicroStrategy' | 'QlikCloud' | 'Sigma' | 'ThoughtSpot' | 'Grafana' | 'Hex' | 'Ssrs' | 'SapS4Hana' | 'Omni'
deletedboolean
extensionobject
sourceHashstring
entityStatus'Draft' | 'In Review' | 'Approved' | 'Archived' | 'Deprecated' | 'Rejected' | 'Unprocessed'
provider'system' | 'user' | 'automation'

Changes

No recorded changes to this operation across all 1 revision of this API.