How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

OpenMetadata Dashboard Data Models API

`Data Models` are the schemas used to build dashboards, charts, or other data assets.

OpenMetadata Dashboard Data Models API is one of 89 APIs that OpenMetadata publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Dashboard Data Models. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 22 operations across 16 paths, and defines 36 schemas. It is described by OpenAPI 3.0.1, at version 1.13.

Requests are made against 2 base URLs: /api, http://localhost:8585/api.

22 operations 16 paths 36 schemas 4 DELETE10 GET2 PATCH1 POST5 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.13
Base URL
https://{your-host}/api/v1
Authentication
HTTP Bearer
License
Resource Areas
1

Authentication & Security 1

OpenMetadata Dashboard Data Models API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

Paths & Operations 22

Across 16 paths, the API surfaces 22 operations — 4 DELETE, 10 GET, 2 PATCH, 1 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.

Dashboard Data Models 22

Data Models are the schemas used to build dashboards, charts, or other data assets.

PUT
/v1/dashboard/datamodels/{id}/followers
Add a follower
addFollowerToDataModel 1 param body → 200404
PUT
/v1/dashboard/datamodels/bulk
Bulk create or update dashboardDataModels
bulkCreateOrUpdateDashboardDataModels 1 param body → 200202400
GET
/v1/dashboard/datamodels
List Dashboard Data Models
listDashboardDataModels 6 params → 200
PUT
/v1/dashboard/datamodels
Create or update dashboard datamodel
createOrUpdateDataModel body → 200
POST
/v1/dashboard/datamodels
Create a dashboard datamodel
createDataModel body → 200400
GET
/v1/dashboard/datamodels/name/{fqn}
Get a dashboard datamodel by fully qualified name
getDataModelByFQN 4 params → 200404
DELETE
/v1/dashboard/datamodels/name/{fqn}
Delete a data model by fully qualified name.
deleteDataModelByFQN 3 params → 200404
PATCH
/v1/dashboard/datamodels/name/{fqn}
Update a dashboard datamodel by name.
patchDataModel 1 param body → default
GET
/v1/dashboard/datamodels/{id}
Get a dashboard datamodel by Id
getDataModelByID 4 params → 200404
DELETE
/v1/dashboard/datamodels/{id}
Delete a data model by id.
deleteDataModel 3 params → 200404
PATCH
/v1/dashboard/datamodels/{id}
Update a dashboard datamodel
patchDataModel_1 1 param body → default
DELETE
/v1/dashboard/datamodels/async/{id}
Asynchronously delete a data model by id.
deleteDataModelAsync 3 params → 200404
DELETE
/v1/dashboard/datamodels/{id}/followers/{userId}
Remove a follower
deleteFollowerFromDataModel 2 params → default
GET
/v1/dashboard/datamodels/{id}/columns
Get data model columns with pagination
getDataModelColumns 5 params → 200
GET
/v1/dashboard/datamodels/name/{fqn}/columns
Get data model columns with pagination by FQN
getDataModelColumnsByFQN 5 params → 200
GET
/v1/dashboard/datamodels/{id}/versions/{version}
Get a version of the dashboard datamodel
getSpecificDataModelVersion 2 params → 200404
GET
/v1/dashboard/datamodels/history
List all entity versions within a time range
listAllEntityVersionsByTimestamp_17 5 params → 200
GET
/v1/dashboard/datamodels/{id}/versions
List dashboard datamodel versions
listAllDataModelVersions 1 param → 200
PUT
/v1/dashboard/datamodels/restore
Restore a soft deleted data model.
restore_16 body → 200
GET
/v1/dashboard/datamodels/name/{fqn}/columns/search
Search data model columns with pagination by FQN
searchDataModelColumnsByFQN 6 params → 200
GET
/v1/dashboard/datamodels/{id}/columns/search
Search data model columns with pagination by ID
searchDataModelColumnsById 6 params → 200
PUT
/v1/dashboard/datamodels/{id}/vote
Update Vote for a Entity
updateVoteForEntity_6 1 param body → 200404

Schemas 36

The contract defines 36 schemas that model the data the API accepts and returns. The most detailed are DashboardDataModel (38 properties), ColumnProfile (30 properties), CreateDashboardDataModel (18 properties), Column (18 properties). Each schema is shown below with its type and property counts.

TagLabelRecognizerMetadata
object
5 properties 3 required
ColumnProfile
object
30 properties 2 required
BulkOperationResult
object
8 properties
ChangeSummaryMap
object
AccessDetails
object
3 properties 1 required
FieldChange
object
3 properties
CoverImage
object
2 properties
DashboardDataModel
object
38 properties 4 required
RestoreEntity
object
1 property 1 required
LifeCycle
object
3 properties
EntityHistory
object
2 properties 2 required
AssetCertification
object
3 properties 3 required
CustomMetricProfile
object
2 properties
VoteRequest
object
1 property
CardinalityDistribution
object
4 properties
ResultList
object
5 properties 1 required
BulkResponse
object
3 properties
Paging
object
5 properties 1 required
DataModelColumnList
object
5 properties 1 required
JsonPatch
object
CustomMetric
object
8 properties 2 required
ChangeDescription
object
5 properties
DashboardDataModelList
object
5 properties 1 required
ChangeEvent
object
14 properties 5 required
UsageStats
object
2 properties 1 required
Column
object
18 properties 2 required
Style
object
3 properties
Votes
object
4 properties
Histogram
object
2 properties
TagLabel
object
13 properties 4 required
PatternMatch
object
3 properties 2 required
TagLabelMetadata
object
2 properties
EntityError
object
2 properties
CreateDashboardDataModel
object
18 properties 4 required
EntityReference
object
9 properties 2 required
UsageDetails
object
4 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

openmetadata-dashboard-data-models-api-openapi.yml Raw ↑

Other APIs OpenMetadata publishes across the network.

OpenMetadata Agent Executions API
OpenMetadata AI Applications API
OpenMetadata AI Governance Policies API
OpenMetadata API Collections API
OpenMetadata API Endpoint API
OpenMetadata API Services API
OpenMetadata Apps API
OpenMetadata Audit Logs API
OpenMetadata Bots API
OpenMetadata ChangeSummary API
OpenMetadata Charts API
OpenMetadata Classifications API
Where this information came from

This is an independent, third-party profile of OpenMetadata Dashboard Data Models API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.