Skip to main content

Dashboards

A Dashboard is a visual collection of charts and data views within a Dashboard Service. It sits below the service and contains Charts.
Entity schema follows the OpenMetadata Standard.

Entity Hierarchy

Dashboards belong to a Dashboard Service:
DashboardService
└── Dashboard (this page)
    └── Chart

Fully Qualified Name

The FQN format for a dashboard is:
service.dashboardName
For example: sample_superset.10

API Endpoints

MethodEndpointDescription
PUT/v1/dashboardsCreate or update a dashboard
POST/v1/dashboardsCreate a dashboard (POST variant)
GET/v1/dashboardsList dashboards
GET/v1/dashboards/{id}Get by ID
GET/v1/dashboards/name/{fqn}Get by FQN
PATCH/v1/dashboards/{id}Update by ID
PATCH/v1/dashboards/name/{fqn}Update by name
DELETE/v1/dashboards/{id}Delete by ID
DELETE/v1/dashboards/name/{fqn}Delete by name
PUT/v1/dashboards/restoreRestore soft-deleted dashboard
GET/v1/dashboards/{id}/versionsList versions
GET/v1/dashboards/{id}/versions/{version}Get specific version
PUT/v1/dashboards/{id}/followersAdd follower
DELETE/v1/dashboards/{id}/followers/{userId}Remove follower
PUT/v1/dashboards/{id}/voteAdd/update vote