mirror of
https://github.com/open-metadata/OpenMetadata.git
synced 2025-08-01 13:48:04 +00:00
a12c99f3ac
* added updated documentation and formatted schema description * added updated documentation and formatted schema description * minor doc changes Co-authored-by: parthp2107 <parth.panchal@deuexsoultions.com>
38 lines
1.5 KiB
Markdown
38 lines
1.5 KiB
Markdown
# Dashboard
|
|
|
|
This schema defines the Dashboard entity. Dashboards are computed from data and visually present data, metrics, and KPIs. They are updated in real-time and allow interactive data exploration.
|
|
|
|
<b id="https/open-metadata.org/schema/entity/data/dashboard.json">$id: https://open-metadata.org/schema/entity/data/dashboard.json</b>
|
|
|
|
Type: `object`
|
|
|
|
## Properties
|
|
- **id** `required`
|
|
- Unique identifier that identifies a dashboard instance.
|
|
- $ref: [../../type/basic.json#/definitions/uuid](../types/basic.md#uuid)
|
|
- **name** `required`
|
|
- Name that identifies this dashboard.
|
|
- Type: `string`
|
|
- Length: between 1 and 64
|
|
- **fullyQualifiedName**
|
|
- A unique name that identifies a dashboard in the format 'ServiceName.DashboardName'.
|
|
- Type: `string`
|
|
- Length: between 1 and 64
|
|
- **description**
|
|
- Description of the dashboard, what it is, and how to use it.
|
|
- Type: `string`
|
|
- **href**
|
|
- Link to the resource corresponding to this entity.
|
|
- $ref: [../../type/basic.json#/definitions/href](../types/basic.md#href)
|
|
- **owner**
|
|
- Owner of this dashboard.
|
|
- $ref: [../../type/entityReference.json](../types/entityreference.md)
|
|
- **service** `required`
|
|
- Link to service where this dashboard is hosted in.
|
|
- $ref: [../../type/entityReference.json](../types/entityreference.md)
|
|
- **usageSummary**
|
|
- Latest usage information for this database.
|
|
- $ref: [../../type/usageDetails.json](../types/usagedetails.md)
|
|
|
|
|
|
_This document was updated on: Thursday, August 26, 2021_ |