Dashboard¶

BI reports and analytics dashboards - the interface to data insights

Overview¶

The Dashboard entity represents business intelligence reports, analytics dashboards, and data visualizations from BI platforms. It captures dashboard metadata, charts, data sources, and usage patterns across tools like Tableau, Looker, Power BI, and others.

Hierarchy:

graph LR
    A[DashboardService] --> B[Dashboard]
    B --> C[Chart]

    style A fill:#667eea,color:#fff
    style B fill:#4facfe,color:#fff
    style C fill:#00f2fe,color:#333

Relationships¶

Dashboard has comprehensive relationships with entities across the metadata platform:

graph TD
    subgraph Service
        A[DashboardService:<br/>tableau_prod]
    end

    subgraph Dashboard Layer
        A --> B[Dashboard:<br/>Sales Performance Q4]
    end

    subgraph Charts
        B --> C1[Chart:<br/>Revenue Trend]
        B --> C2[Chart:<br/>Conversion Funnel]
        B --> C3[Chart:<br/>Regional Sales Map]
        B --> C4[Chart:<br/>Top Products]
    end

    subgraph Ownership
        B -.->|owned by| D1[Team:<br/>Sales Analytics]
        B -.->|owned by| D2[User:<br/>analytics.lead]
    end

    subgraph Governance
        B -.->|in domain| E[Domain:<br/>Sales]
        B -.->|has tags| F1[Tag:<br/>Executive]
        B -.->|has tags| F2[Tag:<br/>Quarterly]
        B -.->|has tags| F3[Tag:<br/>PII]

        B -.->|described by| G1[GlossaryTerm:<br/>Revenue]
        B -.->|described by| G2[GlossaryTerm:<br/>Conversion Rate]
    end

    subgraph Data Sources
        C1 -.->|reads from| H1[Table:<br/>sales.revenue_daily]
        C2 -.->|reads from| H2[Table:<br/>sales.funnel_metrics]
        C3 -.->|reads from| H3[Table:<br/>sales.regional_agg]
        C4 -.->|reads from| H4[Table:<br/>sales.product_sales]

        I1[DataModel:<br/>Sales Mart] -.->|powers| B
    end

    subgraph Upstream Lineage
        J1[Pipeline:<br/>sales_etl] -.->|feeds data to| H1
        J2[Pipeline:<br/>metrics_aggregation] -.->|feeds data to| H2
    end

    subgraph Usage & Access
        K1[User:<br/>sarah.johnson] -.->|views| B
        K2[User:<br/>mike.chen] -.->|views| B
        K3[User:<br/>exec.team] -.->|subscribes to| B
    end

    subgraph Quality & Monitoring
        L1[TestCase:<br/>data_freshness_check] -.->|validates| B
        L2[Dashboard:<br/>Usage Analytics] -.->|monitors| B
    end

    style A fill:#667eea,color:#fff
    style B fill:#4facfe,color:#fff,stroke:#4c51bf,stroke-width:3px
    style C1 fill:#00f2fe,color:#333
    style C2 fill:#00f2fe,color:#333
    style C3 fill:#00f2fe,color:#333
    style C4 fill:#00f2fe,color:#333
    style D1 fill:#43e97b,color:#fff
    style D2 fill:#43e97b,color:#fff
    style E fill:#fa709a,color:#fff
    style F1 fill:#f093fb,color:#fff
    style F2 fill:#f093fb,color:#fff
    style F3 fill:#f093fb,color:#fff
    style G1 fill:#ffd700,color:#333
    style G2 fill:#ffd700,color:#333
    style H1 fill:#764ba2,color:#fff
    style H2 fill:#764ba2,color:#fff
    style H3 fill:#764ba2,color:#fff
    style H4 fill:#764ba2,color:#fff
    style I1 fill:#00ac69,color:#fff
    style J1 fill:#f5576c,color:#fff
    style J2 fill:#f5576c,color:#fff
    style K1 fill:#ff6b6b,color:#fff
    style K2 fill:#ff6b6b,color:#fff
    style K3 fill:#ff6b6b,color:#fff
    style L1 fill:#9b59b6,color:#fff
    style L2 fill:#9b59b6,color:#fff

Relationship Types:

Solid lines (→): Hierarchical containment (Service hosts Dashboard, Dashboard contains Charts)
Dashed lines (-.->): References and associations (ownership, governance, data sources, usage, lineage, quality)

Parent Entities¶

DashboardService: The BI platform hosting this dashboard

Child Entities¶

Chart: Individual visualizations within the dashboard

Associated Entities¶

Owner: User or team owning this dashboard
Domain: Business domain assignment
Tag: Classification tags
GlossaryTerm: Business terminology
Table: Tables used as data sources (via lineage)
DataModel: Data models or datasets used
User: Users who have accessed the dashboard
Pipeline: ETL pipelines feeding the source data
TestCase: Data quality tests validating dashboard freshness

Schema Specifications¶

View the complete Dashboard schema in your preferred format:

JSON SchemaRDFJSON-LD

Complete JSON Schema Definition

{
  "$id": "https://open-metadata.org/schema/entity/data/dashboard.json",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Dashboard",
  "$comment": "@om-entity-type",
  "description": "This schema defines the Dashboard entity. Dashboards are computed from data and visually present data, metrics, and KPIs. They are typically updated in real-time and allow interactive data exploration.",
  "type": "object",
  "javaType": "org.openmetadata.schema.entity.data.Dashboard",
  "javaInterfaces": ["org.openmetadata.schema.EntityInterface"],

  "definitions": {
    "dashboardType": {
      "javaType": "org.openmetadata.schema.type.DashboardType",
      "description": "This schema defines the type used for describing different types of dashboards.",
      "type": "string",
      "default": "Dashboard",
      "enum": [
        "Dashboard",
        "Report"
      ],
      "javaEnums": [
        {
          "name": "Dashboard"
        },
        {
          "name": "Report"
        }
      ]
    }
  },

  "properties": {
    "id": {
      "description": "Unique identifier that identifies a dashboard instance.",
      "$ref": "../../type/basic.json#/definitions/uuid"
    },
    "name": {
      "description": "Name that identifies this dashboard.",
      "$ref": "../../type/basic.json#/definitions/entityName"
    },
    "displayName": {
      "description": "Display Name that identifies this Dashboard. It could be title or label from the source services.",
      "type": "string"
    },
    "fullyQualifiedName": {
      "description": "A unique name that identifies a dashboard in the format 'ServiceName.DashboardName'.",
      "$ref": "../../type/basic.json#/definitions/fullyQualifiedEntityName"
    },
    "description": {
      "description": "Description of the dashboard, what it is, and how to use it.",
      "$ref": "../../type/basic.json#/definitions/markdown"
    },
    "project": {
      "description": "Name of the project / workspace / collection in which the dashboard is contained",
      "type": "string"
    },
    "version": {
      "description": "Metadata version of the entity.",
      "$ref": "../../type/entityHistory.json#/definitions/entityVersion"
    },
    "updatedAt": {
      "description": "Last update time corresponding to the new version of the entity in Unix epoch time milliseconds.",
      "$ref": "../../type/basic.json#/definitions/timestamp"
    },
    "updatedBy": {
      "description": "User who made the update.",
      "type": "string"
    },
    "impersonatedBy": {
      "description": "Bot user that performed the action on behalf of the actual user.",
      "$ref": "../../type/basic.json#/definitions/impersonatedBy"
    },
    "dashboardType": {
      "$ref": "#/definitions/dashboardType"
    },
    "sourceUrl": {
      "description": "Dashboard URL suffix from its service.",
      "$ref": "../../type/basic.json#/definitions/sourceUrl"
    },
    "charts": {
      "description": "All the charts included in this Dashboard.",
      "$ref": "../../type/entityReferenceList.json",
      "default": null
    },
    "dataModels": {
      "description": "List of data models used by this dashboard or the charts contained on it.",
      "$ref": "../../type/entityReferenceList.json",
      "default": null
    },
    "href": {
      "description": "Link to the resource corresponding to this entity.",
      "$ref": "../../type/basic.json#/definitions/href"
    },
    "owners": {
      "description": "Owners of this dashboard.",
      "$ref": "../../type/entityReferenceList.json"
    },
    "followers": {
      "description": "Followers of this dashboard.",
      "$ref": "../../type/entityReferenceList.json"
    },
    "tags": {
      "description": "Tags for this dashboard.",
      "type": "array",
      "items": {
        "$ref": "../../type/tagLabel.json"
      },
      "default": []
    },
    "service": {
      "description": "Link to service where this dashboard is hosted in.",
      "$ref": "../../type/entityReference.json"
    },
    "serviceType": {
      "description": "Service type where this dashboard is hosted in.",
      "$ref": "../services/dashboardService.json#/definitions/dashboardServiceType"
    },
    "usageSummary": {
      "description": "Latest usage information for this dashboard.",
      "$ref": "../../type/usageDetails.json",
      "default": null
    },
    "changeDescription": {
      "description": "Change that lead to this version of the entity.",
      "$ref": "../../type/entityHistory.json#/definitions/changeDescription"
    },
    "incrementalChangeDescription": {
      "description": "Change that lead to this version of the entity.",
      "$ref": "../../type/entityHistory.json#/definitions/changeDescription"
    },
    "deleted": {
      "description": "When `true` indicates the entity has been soft deleted.",
      "type": "boolean",
      "default": false
    },
    "extension": {
      "description": "Entity extension data with custom attributes added to the entity.",
      "$ref": "../../type/basic.json#/definitions/entityExtension"
    },
    "domains": {
      "description": "Domains the Dashboard belongs to. When not set, the Dashboard inherits the domain from the dashboard service it belongs to.",
      "$ref": "../../type/entityReferenceList.json"
    },
    "dataProducts": {
      "description": "List of data products this entity is part of.",
      "$ref": "../../type/entityReferenceList.json"
    },
    "votes": {
      "description": "Votes on the entity.",
      "$ref": "../../type/votes.json"
    },
    "lifeCycle": {
      "description": "Life Cycle properties of the entity",
      "$ref": "../../type/lifeCycle.json"
    },
    "certification": {
      "$ref": "../../type/assetCertification.json"
    },
    "sourceHash": {
      "description": "Source hash of the entity",
      "type": "string",
      "minLength": 1,
      "maxLength": 32
    },
    "entityStatus": {
      "description": "Status of the Dashboard.",
      "$ref": "../../type/status.json"
    }
  },

  "required": ["id", "name", "service"],
  "additionalProperties": false
}

View Full JSON Schema →

RDF/OWL Ontology Definition

@prefix om: <https://open-metadata.org/schema/> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix owl: <http://www.w3.org/2001/XMLSchema#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .

# Dashboard Class Definition
om:Dashboard a owl:Class ;
    rdfs:subClassOf om:DataAsset ;
    rdfs:label "Dashboard" ;
    rdfs:comment "A BI dashboard or report containing data visualizations" ;
    om:hierarchyLevel 2 .

# Properties
om:dashboardName a owl:DatatypeProperty ;
    rdfs:domain om:Dashboard ;
    rdfs:range xsd:string ;
    rdfs:label "name" ;
    rdfs:comment "Name of the dashboard" .

om:fullyQualifiedName a owl:DatatypeProperty ;
    rdfs:domain om:Dashboard ;
    rdfs:range xsd:string ;
    rdfs:label "fullyQualifiedName" ;
    rdfs:comment "Complete hierarchical name: service.dashboard" .

om:dashboardType a owl:DatatypeProperty ;
    rdfs:domain om:Dashboard ;
    rdfs:range om:DashboardType ;
    rdfs:label "dashboardType" ;
    rdfs:comment "Type: Dashboard, Report, Story, etc." .

om:dashboardUrl a owl:DatatypeProperty ;
    rdfs:domain om:Dashboard ;
    rdfs:range xsd:anyURI ;
    rdfs:label "dashboardUrl" ;
    rdfs:comment "External URL to access the dashboard" .

om:hasChart a owl:ObjectProperty ;
    rdfs:domain om:Dashboard ;
    rdfs:range om:Chart ;
    rdfs:label "hasChart" ;
    rdfs:comment "Charts contained in this dashboard" .

om:usesDataModel a owl:ObjectProperty ;
    rdfs:domain om:Dashboard ;
    rdfs:range om:DataModel ;
    rdfs:label "usesDataModel" ;
    rdfs:comment "Data models used by this dashboard" .

om:belongsToService a owl:ObjectProperty ;
    rdfs:domain om:Dashboard ;
    rdfs:range om:DashboardService ;
    rdfs:label "belongsToService" ;
    rdfs:comment "Dashboard service hosting this dashboard" .

om:hasOwners a owl:ObjectProperty ;
    rdfs:domain om:Dashboard ;
    rdfs:range om:Owner ;
    rdfs:label "hasOwners" ;
    rdfs:comment "Users or teams that own this dashboard" .

om:hasTag a owl:ObjectProperty ;
    rdfs:domain om:Dashboard ;
    rdfs:range om:Tag ;
    rdfs:label "hasTag" ;
    rdfs:comment "Classification tags applied to dashboard" .

om:linkedToGlossaryTerm a owl:ObjectProperty ;
    rdfs:domain om:Dashboard ;
    rdfs:range om:GlossaryTerm ;
    rdfs:label "linkedToGlossaryTerm" ;
    rdfs:comment "Business glossary terms" .

# Dashboard Type Enumeration
om:DashboardType a owl:Class ;
    owl:oneOf (
        om:DashboardType_Dashboard
        om:DashboardType_Report
    ) .

# Example Instance
ex:salesOverview a om:Dashboard ;
    om:dashboardName "sales_overview" ;
    om:fullyQualifiedName "tableau_prod.sales_overview" ;
    om:displayName "Sales Overview Dashboard" ;
    om:dashboardType om:DashboardType_Dashboard ;
    om:sourceUrl "/views/sales_overview" ;
    om:belongsToService ex:tableauProdService ;
    om:hasOwners ex:salesTeam ;
    om:hasFollowers ex:user1, ex:user2 ;
    om:hasTag ex:tierGold ;
    om:linkedToGlossaryTerm ex:revenueTerm ;
    om:hasChart ex:monthlySalesChart ;
    om:hasChart ex:regionalBreakdownChart ;
    om:inDomains ex:salesDomain .

View Full RDF Ontology →

JSON-LD Context and Example

{
  "@context": {
    "@vocab": "https://open-metadata.org/schema/",
    "om": "https://open-metadata.org/schema/",
    "rdfs": "http://www.w3.org/2000/01/rdf-schema#",
    "xsd": "http://www.w3.org/2001/XMLSchema#",

    "Dashboard": "om:Dashboard",
    "name": {
      "@id": "om:dashboardName",
      "@type": "xsd:string"
    },
    "fullyQualifiedName": {
      "@id": "om:fullyQualifiedName",
      "@type": "xsd:string"
    },
    "displayName": {
      "@id": "om:displayName",
      "@type": "xsd:string"
    },
    "description": {
      "@id": "om:description",
      "@type": "xsd:string"
    },
    "dashboardType": {
      "@id": "om:dashboardType",
      "@type": "@vocab"
    },
    "sourceUrl": {
      "@id": "om:sourceUrl",
      "@type": "xsd:anyURI"
    },
    "charts": {
      "@id": "om:hasChart",
      "@type": "@id",
      "@container": "@list"
    },
    "dataModels": {
      "@id": "om:usesDataModel",
      "@type": "@id",
      "@container": "@set"
    },
    "service": {
      "@id": "om:belongsToService",
      "@type": "@id"
    },
    "owners": {
      "@id": "om:hasOwners",
      "@type": "@id",
      "@container": "@set"
    },
    "followers": {
      "@id": "om:hasFollowers",
      "@type": "@id",
      "@container": "@set"
    },
    "domains": {
      "@id": "om:inDomains",
      "@type": "@id",
      "@container": "@set"
    },
    "dataProducts": {
      "@id": "om:partOfDataProducts",
      "@type": "@id",
      "@container": "@set"
    },
    "tags": {
      "@id": "om:hasTag",
      "@type": "@id",
      "@container": "@set"
    },
    "votes": {
      "@id": "om:hasVotes",
      "@type": "@id"
    },
    "lifeCycle": {
      "@id": "om:hasLifeCycle",
      "@type": "@id"
    },
    "certification": {
      "@id": "om:hasCertification",
      "@type": "@id"
    }
  }
}

Example JSON-LD Instance:

{
  "@context": "https://open-metadata.org/context/dashboard.jsonld",
  "@type": "Dashboard",
  "@id": "https://example.com/dashboards/sales_overview",

  "name": "sales_overview",
  "fullyQualifiedName": "tableau_prod.sales_overview",
  "displayName": "Sales Overview Dashboard",
  "description": "Executive dashboard showing sales performance metrics",
  "dashboardType": "Dashboard",
  "sourceUrl": "/views/sales_overview",

  "service": {
    "@id": "https://example.com/services/tableau_prod",
    "@type": "DashboardService",
    "name": "tableau_prod"
  },

  "owners": [
    {
      "@id": "https://example.com/teams/sales-team",
      "@type": "Team",
      "name": "sales-team",
      "displayName": "Sales Team"
    }
  ],

  "followers": [
    {
      "@id": "https://example.com/users/user1",
      "@type": "User",
      "name": "user1"
    }
  ],

  "domains": [
    {
      "@id": "https://example.com/domains/Sales",
      "@type": "Domain",
      "name": "Sales"
    }
  ],

  "tags": [
    {
      "@id": "https://open-metadata.org/tags/Tier/Gold",
      "tagFQN": "Tier.Gold"
    }
  ],

  "charts": [
    {
      "@type": "Chart",
      "@id": "https://example.com/charts/monthly_sales",
      "name": "monthly_sales",
      "displayName": "Monthly Sales Trend"
    },
    {
      "@type": "Chart",
      "@id": "https://example.com/charts/regional_breakdown",
      "name": "regional_breakdown",
      "displayName": "Sales by Region"
    }
  ]
}

View Full JSON-LD Context →

Use Cases¶

Catalog all BI dashboards across the organization
Document dashboard purpose, metrics, and KPIs
Track dashboard ownership and stakeholders
Discover dashboards by business domain or topic
Capture lineage from source tables to dashboards
Monitor dashboard usage and adoption
Apply governance tags to sensitive dashboards
Centralize documentation for business reports
Track dashboard dependencies and refresh schedules

JSON Schema Specification¶

Core Properties¶

`id` (uuid)¶

Type: string (UUID format) Required: Yes (system-generated) Description: Unique identifier for this dashboard instance

{
  "id": "2b3c4d5e-6f7a-8b9c-0d1e-2f3a4b5c6d7e"
}

`name` (entityName)¶

Type: string Required: Yes Pattern: ^[^.]*$ (no dots allowed) Min Length: 1 Max Length: 256 Description: Name of the dashboard (unqualified)

{
  "name": "sales_overview"
}

`fullyQualifiedName` (fullyQualifiedEntityName)¶

Type: string Required: Yes (system-generated) Pattern: ^((?!::).)*$ Description: Fully qualified name in the format service.dashboard

{
  "fullyQualifiedName": "tableau_prod.sales_overview"
}

`displayName`¶

Type: string Required: No Description: Human-readable display name

{
  "displayName": "Sales Overview Dashboard"
}

`description` (markdown)¶

Type: string (Markdown format) Required: No Description: Rich text description of the dashboard's purpose and usage

{
  "description": "# Sales Overview Dashboard\n\nExecutive dashboard showing sales performance metrics across all regions.\n\n## Key Metrics\n- Total Revenue\n- Sales Growth %\n- Regional Breakdown\n- Top Products\n\n## Refresh Schedule\nUpdated daily at 6 AM EST"
}

Dashboard Configuration¶

`dashboardType` (DashboardType enum)¶

Type: string enum Required: No (default: Dashboard) Allowed Values:

Dashboard - Interactive dashboard
Report - Static report

{
  "dashboardType": "Dashboard"
}

`sourceUrl` (sourceUrl)¶

Type: string Required: No Description: Dashboard URL suffix from its service

{
  "sourceUrl": "/views/sales_overview"
}

`project` (string)¶

Type: string Required: No Description: Project, workspace, or folder containing this dashboard

{
  "project": "Sales Analytics"
}

Content Properties¶

`charts[]` (Chart[])¶

Type: array of Chart entity references Required: No Description: Charts and visualizations within this dashboard

{
  "charts": [
    {
      "id": "chart-1-uuid",
      "type": "chart",
      "name": "monthly_sales",
      "displayName": "Monthly Sales Trend",
      "fullyQualifiedName": "tableau_prod.sales_overview.monthly_sales"
    },
    {
      "id": "chart-2-uuid",
      "type": "chart",
      "name": "regional_breakdown",
      "displayName": "Sales by Region",
      "fullyQualifiedName": "tableau_prod.sales_overview.regional_breakdown"
    },
    {
      "id": "chart-3-uuid",
      "type": "chart",
      "name": "top_products",
      "displayName": "Top 10 Products",
      "fullyQualifiedName": "tableau_prod.sales_overview.top_products"
    }
  ]
}

`dataModels[]` (DataModel[])¶

Type: array of DataModel entity references Required: No Description: Data models or datasets used by this dashboard (e.g., Looker LookML models)

{
  "dataModels": [
    {
      "id": "model-1-uuid",
      "type": "dataModel",
      "name": "sales_model",
      "fullyQualifiedName": "looker_prod.sales_model"
    }
  ]
}

Location Properties¶

`service` (EntityReference)¶

Type: object Required: Yes Description: Reference to parent dashboard service

{
  "service": {
    "id": "service-uuid",
    "type": "dashboardService",
    "name": "tableau_prod",
    "fullyQualifiedName": "tableau_prod"
  }
}

Governance Properties¶

`owners` (EntityReferenceList)¶

Type: array of entity references Required: No Description: Owners of this dashboard

{
  "owners": [
    {
      "id": "owner-uuid",
      "type": "team",
      "name": "sales-team",
      "displayName": "Sales Team"
    }
  ]
}

`followers` (EntityReferenceList)¶

Type: array of entity references Required: No Description: Followers of this dashboard

{
  "followers": [
    {
      "id": "user-uuid",
      "type": "user",
      "name": "john.doe",
      "displayName": "John Doe"
    }
  ]
}

`domains` (EntityReferenceList)¶

Type: array of entity references Required: No Description: Domains the Dashboard belongs to. When not set, the Dashboard inherits the domain from the dashboard service it belongs to.

{
  "domains": [
    {
      "id": "domain-uuid",
      "type": "domain",
      "name": "Sales",
      "fullyQualifiedName": "Sales"
    }
  ]
}

`dataProducts` (EntityReferenceList)¶

Type: array of entity references Required: No Description: List of data products this entity is part of

{
  "dataProducts": [
    {
      "id": "product-uuid",
      "type": "dataProduct",
      "name": "sales_analytics",
      "fullyQualifiedName": "Sales.SalesAnalytics"
    }
  ]
}

`tags[]` (TagLabel[])¶

Type: array Required: No Description: Classification tags applied to the dashboard

{
  "tags": [
    {
      "tagFQN": "Tier.Gold",
      "description": "Critical executive dashboard",
      "source": "Classification",
      "labelType": "Manual",
      "state": "Confirmed"
    },
    {
      "tagFQN": "BusinessCritical",
      "source": "Classification",
      "labelType": "Manual",
      "state": "Confirmed"
    }
  ]
}

`votes` (Votes)¶

Type: object Required: No Description: Votes on the entity

{
  "votes": {
    "upVotes": 15,
    "downVotes": 2,
    "upVoters": [
      {
        "id": "user-uuid-1",
        "type": "user"
      }
    ],
    "downVoters": []
  }
}

`lifeCycle` (LifeCycle)¶

Type: object Required: No Description: Life Cycle properties of the entity

{
  "lifeCycle": {
    "created": {
      "timestamp": 1704067200000,
      "user": "john.doe"
    },
    "updated": {
      "timestamp": 1704240000000,
      "user": "jane.smith"
    }
  }
}

`certification` (AssetCertification)¶

Type: object Required: No Description: Certification information for the dashboard

{
  "certification": {
    "certifiedBy": "data-governance-team",
    "certifiedAt": 1704067200000,
    "expiresAt": 1735689600000,
    "status": "Certified"
  }
}

`sourceHash` (string)¶

Type: string Required: No Min Length: 1 Max Length: 32 Description: Source hash of the entity

{
  "sourceHash": "a1b2c3d4e5f6"
}

`entityStatus` (Status)¶

Type: object Required: No Description: Status of the Dashboard

{
  "entityStatus": "Active"
}

Usage Properties¶

`usageSummary` (UsageDetails)¶

Type: object Required: No (system-generated) Description: Dashboard usage statistics

{
  "usageSummary": {
    "dailyStats": {
      "count": 45,
      "percentileRank": 92.5
    },
    "weeklyStats": {
      "count": 287,
      "percentileRank": 88.3
    },
    "monthlyStats": {
      "count": 1243,
      "percentileRank": 95.1
    },
    "date": "2024-01-15"
  }
}

Versioning Properties¶

`version` (entityVersion)¶

Type: number Required: Yes (system-managed) Description: Metadata version number, incremented on changes

{
  "version": 1.8
}

`updatedAt` (timestamp)¶

Type: integer (Unix epoch milliseconds) Required: Yes (system-managed) Description: Last update timestamp

{
  "updatedAt": 1704240000000
}

`updatedBy` (string)¶

Type: string Required: Yes (system-managed) Description: User who made the update

{
  "updatedBy": "john.doe"
}

`impersonatedBy` (impersonatedBy)¶

Type: object Required: No Description: Bot user that performed the action on behalf of the actual user

{
  "impersonatedBy": {
    "id": "bot-uuid",
    "type": "bot",
    "name": "ingestion-bot"
  }
}

`href` (href)¶

Type: string (URI format) Required: No (system-generated) Description: Link to the resource corresponding to this entity

{
  "href": "http://localhost:8585/api/v1/dashboards/2b3c4d5e-6f7a-8b9c-0d1e-2f3a4b5c6d7e"
}

`changeDescription` (ChangeDescription)¶

Type: object Required: No (system-generated) Description: Change that lead to this version of the entity

{
  "changeDescription": {
    "fieldsAdded": [],
    "fieldsUpdated": [
      {
        "name": "description",
        "oldValue": "Old description",
        "newValue": "Updated description"
      }
    ],
    "fieldsDeleted": [],
    "previousVersion": 1.7
  }
}

`incrementalChangeDescription` (ChangeDescription)¶

Type: object Required: No (system-generated) Description: Change that lead to this version of the entity

{
  "incrementalChangeDescription": {
    "fieldsAdded": [
      {
        "name": "tags",
        "newValue": "[{\"tagFQN\": \"Tier.Gold\"}]"
      }
    ],
    "fieldsUpdated": [],
    "fieldsDeleted": []
  }
}

`deleted` (boolean)¶

Type: boolean Required: No (default: false) Description: When true indicates the entity has been soft deleted

{
  "deleted": false
}

`extension` (entityExtension)¶

Type: object Required: No Description: Entity extension data with custom attributes added to the entity

{
  "extension": {
    "customProperty1": "value1",
    "customProperty2": 123
  }
}

`serviceType` (DashboardServiceType)¶

Type: string enum Required: No (system-generated) Description: Service type where this dashboard is hosted in

{
  "serviceType": "Tableau"
}

Complete Example¶

{
  "id": "2b3c4d5e-6f7a-8b9c-0d1e-2f3a4b5c6d7e",
  "name": "sales_overview",
  "fullyQualifiedName": "tableau_prod.sales_overview",
  "displayName": "Sales Overview Dashboard",
  "description": "# Sales Overview Dashboard\n\nExecutive dashboard showing sales performance metrics across all regions.",
  "dashboardType": "Dashboard",
  "sourceUrl": "/views/sales_overview",
  "project": "Sales Analytics",
  "href": "http://localhost:8585/api/v1/dashboards/2b3c4d5e-6f7a-8b9c-0d1e-2f3a4b5c6d7e",
  "charts": [
    {
      "id": "chart-1-uuid",
      "type": "chart",
      "name": "monthly_sales",
      "displayName": "Monthly Sales Trend"
    },
    {
      "id": "chart-2-uuid",
      "type": "chart",
      "name": "regional_breakdown",
      "displayName": "Sales by Region"
    }
  ],
  "dataModels": [
    {
      "id": "model-1-uuid",
      "type": "dataModel",
      "name": "sales_model"
    }
  ],
  "service": {
    "id": "service-uuid",
    "type": "dashboardService",
    "name": "tableau_prod"
  },
  "serviceType": "Tableau",
  "owners": [
    {
      "id": "owner-uuid",
      "type": "team",
      "name": "sales-team",
      "displayName": "Sales Team"
    }
  ],
  "followers": [
    {
      "id": "user-uuid",
      "type": "user",
      "name": "john.doe"
    }
  ],
  "domains": [
    {
      "id": "domain-uuid",
      "type": "domain",
      "name": "Sales"
    }
  ],
  "dataProducts": [
    {
      "id": "product-uuid",
      "type": "dataProduct",
      "name": "sales_analytics"
    }
  ],
  "tags": [
    {
      "tagFQN": "Tier.Gold",
      "source": "Classification",
      "labelType": "Manual",
      "state": "Confirmed"
    },
    {
      "tagFQN": "BusinessCritical",
      "source": "Classification",
      "labelType": "Manual",
      "state": "Confirmed"
    }
  ],
  "votes": {
    "upVotes": 15,
    "downVotes": 2
  },
  "lifeCycle": {
    "created": {
      "timestamp": 1704067200000,
      "user": "john.doe"
    }
  },
  "certification": {
    "certifiedBy": "data-governance-team",
    "certifiedAt": 1704067200000,
    "status": "Certified"
  },
  "usageSummary": {
    "dailyStats": {
      "count": 45,
      "percentileRank": 92.5
    },
    "weeklyStats": {
      "count": 287,
      "percentileRank": 88.3
    },
    "date": "2024-01-15"
  },
  "version": 1.8,
  "updatedAt": 1704240000000,
  "updatedBy": "john.doe",
  "deleted": false,
  "sourceHash": "a1b2c3d4e5f6"
}

RDF Representation¶

Ontology Class¶

@prefix om: <https://open-metadata.org/schema/> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix owl: <http://www.w3.org/2001/XMLSchema#> .

om:Dashboard a owl:Class ;
    rdfs:subClassOf om:DataAsset ;
    rdfs:label "Dashboard" ;
    rdfs:comment "A BI dashboard or report" ;
    om:hasProperties [
        om:name "string" ;
        om:dashboardType "DashboardType" ;
        om:sourceUrl "uri" ;
        om:charts "Chart[]" ;
        om:dataModels "DataModel[]" ;
        om:service "DashboardService" ;
        om:owners "Owner[]" ;
        om:followers "User[]" ;
        om:domains "Domain[]" ;
        om:dataProducts "DataProduct[]" ;
        om:tags "Tag[]" ;
        om:votes "Votes" ;
        om:lifeCycle "LifeCycle" ;
        om:certification "AssetCertification" ;
    ] .

Instance Example¶

@prefix om: <https://open-metadata.org/schema/> .
@prefix ex: <https://example.com/dashboards/> .

ex:sales_overview a om:Dashboard ;
    om:name "sales_overview" ;
    om:fullyQualifiedName "tableau_prod.sales_overview" ;
    om:displayName "Sales Overview Dashboard" ;
    om:description "Executive sales dashboard" ;
    om:dashboardType "Dashboard" ;
    om:sourceUrl "/views/sales_overview" ;
    om:belongsToService ex:tableau_prod ;
    om:hasOwners ex:sales_team ;
    om:hasFollowers ex:user1, ex:user2 ;
    om:inDomains ex:sales_domain ;
    om:partOfDataProducts ex:sales_analytics ;
    om:hasTag ex:tier_gold ;
    om:hasChart ex:monthly_sales_chart ;
    om:hasChart ex:regional_breakdown_chart ;
    om:hasVotes ex:votes_summary ;
    om:hasCertification ex:governance_certification .

JSON-LD Context¶

{
  "@context": {
    "@vocab": "https://open-metadata.org/schema/",
    "Dashboard": "om:Dashboard",
    "name": "om:name",
    "fullyQualifiedName": "om:fullyQualifiedName",
    "displayName": "om:displayName",
    "dashboardType": {
      "@id": "om:dashboardType",
      "@type": "@vocab"
    },
    "sourceUrl": {
      "@id": "om:sourceUrl",
      "@type": "xsd:anyURI"
    },
    "charts": {
      "@id": "om:hasChart",
      "@type": "@id",
      "@container": "@list"
    },
    "dataModels": {
      "@id": "om:usesDataModel",
      "@type": "@id",
      "@container": "@set"
    },
    "service": {
      "@id": "om:belongsToService",
      "@type": "@id"
    },
    "owners": {
      "@id": "om:hasOwners",
      "@type": "@id",
      "@container": "@set"
    },
    "followers": {
      "@id": "om:hasFollowers",
      "@type": "@id",
      "@container": "@set"
    },
    "domains": {
      "@id": "om:inDomains",
      "@type": "@id",
      "@container": "@set"
    },
    "dataProducts": {
      "@id": "om:partOfDataProducts",
      "@type": "@id",
      "@container": "@set"
    },
    "tags": {
      "@id": "om:hasTag",
      "@type": "@id",
      "@container": "@set"
    },
    "votes": {
      "@id": "om:hasVotes",
      "@type": "@id"
    },
    "lifeCycle": {
      "@id": "om:hasLifeCycle",
      "@type": "@id"
    },
    "certification": {
      "@id": "om:hasCertification",
      "@type": "@id"
    }
  }
}

Custom Properties¶

This entity supports custom properties through the extension field. Common custom properties include:

Data Classification: Sensitivity level
Cost Center: Billing allocation
Retention Period: Data retention requirements
Application Owner: Owning application/team

See Custom Properties for details on defining and using custom properties.

Followers¶

Users can follow dashboards to receive notifications about updates, chart changes, and data source modifications. See Followers for details.

API Operations¶

All Dashboard operations are available under the /v1/dashboards endpoint.

List Dashboards¶

Get a list of dashboards, optionally filtered by service.

GET /v1/dashboards
Query Parameters:
  - fields: Fields to include (charts, tags, owners, followers, domains, dataProducts, usageSummary, dataModels, etc.)
  - service: Filter by dashboard service name
  - limit: Number of results (1-1000000, default 10)
  - before/after: Cursor-based pagination
  - include: all | deleted | non-deleted (default: non-deleted)

Response: DashboardList

Create Dashboard¶

Create a new dashboard under a dashboard service.

POST /v1/dashboards
Content-Type: application/json

{
  "name": "sales_overview",
  "service": "tableau_prod",
  "displayName": "Sales Overview Dashboard",
  "description": "Executive sales performance dashboard",
  "sourceUrl": "/views/sales_overview",
  "dashboardType": "Dashboard",
  "charts": [
    {
      "id": "chart-1-uuid",
      "type": "chart"
    },
    {
      "id": "chart-2-uuid",
      "type": "chart"
    }
  ],
  "dataModels": [
    {
      "id": "model-uuid",
      "type": "dashboardDataModel"
    }
  ],
  "owners": [
    {
      "id": "owner-uuid",
      "type": "team"
    }
  ],
  "tags": [
    {"tagFQN": "BusinessCritical"}
  ]
}

Response: Dashboard

Get Dashboard by Name¶

Get a dashboard by its fully qualified name.

GET /v1/dashboards/name/{fqn}
Query Parameters:
  - fields: Fields to include (charts, tags, owners, followers, domains, dataProducts, usageSummary, dataModels, etc.)
  - include: all | deleted | non-deleted

Example:
GET /v1/dashboards/name/tableau_prod.sales_overview?fields=charts,tags,owners,followers,usageSummary

Response: Dashboard

Get Dashboard by ID¶

Get a dashboard by its unique identifier.

GET /v1/dashboards/{id}
Query Parameters:
  - fields: Fields to include
  - include: all | deleted | non-deleted

Response: Dashboard

Update Dashboard¶

Update a dashboard using JSON Patch.

PATCH /v1/dashboards/name/{fqn}
Content-Type: application/json-patch+json

[
  {"op": "add", "path": "/tags/-", "value": {"tagFQN": "Tier.Gold"}},
  {"op": "replace", "path": "/description", "value": "Updated sales dashboard"},
  {"op": "add", "path": "/owners/-", "value": {"id": "...", "type": "team"}}
]

Response: Dashboard

Create or Update Dashboard¶

Create a new dashboard or update if it exists.

PUT /v1/dashboards
Content-Type: application/json

{
  "name": "revenue_analytics",
  "service": "powerbi_prod",
  "sourceUrl": "/reports/revenue_analytics",
  "charts": [...]
}

Response: Dashboard

Delete Dashboard¶

Delete a dashboard by fully qualified name.

DELETE /v1/dashboards/name/{fqn}
Query Parameters:
  - hardDelete: Permanently delete (default: false)

Response: 200 OK

Update Dashboard Charts¶

Update the charts associated with a dashboard.

PUT /v1/dashboards/{id}/charts
Content-Type: application/json

{
  "charts": [
    {"id": "chart-uuid-1", "type": "chart"},
    {"id": "chart-uuid-2", "type": "chart"}
  ]
}

Response: Dashboard

Get Dashboard Usage¶

Get usage statistics for a dashboard.

GET /v1/dashboards/{id}/usage
Query Parameters:
  - days: Number of days for usage data (default: 30)

Response: UsageDetails (view count, users, etc.)

Get Dashboard Versions¶

Get all versions of a dashboard.

GET /v1/dashboards/{id}/versions

Response: EntityHistory

Follow Dashboard¶

Add a follower to a dashboard.

PUT /v1/dashboards/{id}/followers/{userId}

Response: ChangeEvent

Get Followers¶

Get all followers of a dashboard.

GET /v1/dashboards/{id}/followers

Response: EntityReference[]

Vote on Dashboard¶

Upvote or downvote a dashboard.

PUT /v1/dashboards/{id}/vote
Content-Type: application/json

{
  "vote": "upvote"
}

Response: ChangeEvent

Bulk Operations¶

Create or update multiple dashboards.

PUT /v1/dashboards/bulk
Content-Type: application/json

{
  "entities": [...]
}

Response: BulkOperationResult

Dashboard Service - Service configuration
Chart - Chart entity specification
Lineage - Dashboard lineage
Usage Analytics - Usage tracking
Governance - Governance policies

Dashboard¶

Overview¶

Relationships¶

Parent Entities¶

Child Entities¶

Associated Entities¶

Schema Specifications¶

Use Cases¶

JSON Schema Specification¶

Core Properties¶

id (uuid)¶

name (entityName)¶

fullyQualifiedName (fullyQualifiedEntityName)¶

displayName¶

description (markdown)¶

Dashboard Configuration¶

dashboardType (DashboardType enum)¶

sourceUrl (sourceUrl)¶

project (string)¶