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 Metrics API

`Metrics` are measurements computed from data such as `Monthly Active Users`. Some of the metrics that measures used to determine performance against an objective are called KPIs or Key Performance Indicators, such as `User Retention`.

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

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

This API exposes 19 operations across 13 paths, and defines 28 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.

19 operations 13 paths 28 schemas 4 DELETE7 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 Metrics API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

Paths & Operations 19

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

Metrics 19

Metrics are measurements computed from data such as Monthly Active Users. Some of the metrics that measures used to determine performance against an objective are called KPIs or K…

PUT
/v1/metrics/{id}/followers
Add a follower
addFollower_7 1 param body → 200404
PUT
/v1/metrics/bulk
Bulk create or update metrics
bulkCreateOrUpdateMetrics 1 param body → 200202400
GET
/v1/metrics
List metrics
listMetrics 5 params → 200
PUT
/v1/metrics
Create or update a metric
createOrUpdateMetric body → 200400
POST
/v1/metrics
Create a Metric
createMetric body → 200400
GET
/v1/metrics/name/{fqn}
Get a Metric by fully qualified name.
getMetricByFQN 4 params → 200404
DELETE
/v1/metrics/name/{fqn}
Delete a Metric by fully qualified name
deleteAPIEndpointByFQN_1 2 params → 200404
PATCH
/v1/metrics/name/{fqn}
Update a Metric using name.
patchMetric 1 param body → default
GET
/v1/metrics/{id}
Get a metric by Id
getMetricByID 4 params → 200404
DELETE
/v1/metrics/{id}
Delete a Metric by id
deleteMetric 2 params → 200404
PATCH
/v1/metrics/{id}
Update a Metric
patchMetric_1 1 param body → default
DELETE
/v1/metrics/async/{id}
Asynchronously delete a Metric by id
deleteMetricAsync 2 params → 200404
DELETE
/v1/metrics/{id}/followers/{userId}
Remove a follower
deleteFollower_10 2 params → 200
GET
/v1/metrics/customUnits
Get list of custom units of measurement
getCustomUnitsOfMeasurement → 200
GET
/v1/metrics/{id}/versions/{version}
Get a version of the Metric
getSpecificEndpointVersion_1 2 params → 200404
GET
/v1/metrics/history
List all entity versions within a time range
listAllEntityVersionsByTimestamp_33 5 params → 200
GET
/v1/metrics/{id}/versions
List Metric versions
listAllMetricVersion 1 param → 200
PUT
/v1/metrics/restore
Restore a soft deleted Metric.
restore_24 body → 200
PUT
/v1/metrics/{id}/vote
Update Vote for a Metric
updateVoteForMetric 1 param body → 200404

Schemas 28

The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are Metric (37 properties), CreateMetric (16 properties), ChangeEvent (14 properties), TagLabel (13 properties). Each schema is shown below with its type and property counts.

TagLabelRecognizerMetadata
object
5 properties 3 required
ChangeSummaryMap
object
AccessDetails
object
3 properties 1 required
RestoreEntity
object
1 property 1 required
FieldChange
object
3 properties
CoverImage
object
2 properties
LifeCycle
object
3 properties
MetricExpression
object
2 properties
MetricsList
object
5 properties 1 required
EntityHistory
object
2 properties 2 required
AssetCertification
object
3 properties 3 required
VoteRequest
object
1 property
ResultList
object
5 properties 1 required
Paging
object
5 properties 1 required
JsonPatch
object
ChangeDescription
object
5 properties
ChangeEvent
object
14 properties 5 required
UsageStats
object
2 properties 1 required
Style
object
3 properties
Votes
object
4 properties
TagLabel
object
13 properties 4 required
PatternMatch
object
3 properties 2 required
Metric
object
37 properties 2 required
TagLabelMetadata
object
2 properties
EntityError
object
2 properties
CreateMetric
object
16 properties 1 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-metrics-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 Metrics 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.