Metrics

A Metric defines a governed business or operational measurement, including its calculation, unit, granularity, ownership, and relationships to data assets and other metrics. A metric documents a definition. It isn’t a key performance indicator (KPI), and KPIs can’t be linked to metrics. The entity schema follows the OpenMetadata Standard.

Global Namespace

Metrics do not belong to a service or another parent entity. Metric names are globally unique, so a metric’s fully qualified name is the same as its name:

metricName

For example: customer_retention_rate. Use the assets, domains, and dataProducts relationships to connect a metric to the data and governance context it describes.

SDK References

Python: metadata.sdk.entities.Metrics
Java: org.openmetadata.sdk.fluent.Metrics or OpenMetadataClient.metrics()

API Endpoints

Method	Endpoint	Description
`PUT`	`/v1/metrics`	Create or update a metric
`POST`	`/v1/metrics`	Create a metric
`PUT`	`/v1/metrics/bulk`	Create or update metrics in bulk
`GET`	`/v1/metrics/documentation/csv`	Get CSV field documentation
`GET`	`/v1/metrics/name/{name}/export`	Export one or all metrics as CSV
`GET`	`/v1/metrics/name/{name}/exportAsync`	Export metrics asynchronously
`PUT`	`/v1/metrics/name/{name}/import`	Validate or import metrics from CSV
`PUT`	`/v1/metrics/name/{name}/importAsync`	Import metrics asynchronously
`GET`	`/v1/metrics`	List metrics
`GET`	`/v1/metrics/{id}`	Get by ID
`GET`	`/v1/metrics/name/{fqn}`	Get by FQN
`PATCH`	`/v1/metrics/{id}`	Update by ID
`PATCH`	`/v1/metrics/name/{fqn}`	Update by name
`DELETE`	`/v1/metrics/{id}`	Delete by ID
`DELETE`	`/v1/metrics/async/{id}`	Delete asynchronously
`DELETE`	`/v1/metrics/name/{fqn}`	Delete by name
`PUT`	`/v1/metrics/restore`	Restore a soft-deleted metric
`GET`	`/v1/metrics/{id}/versions`	List versions
`GET`	`/v1/metrics/{id}/versions/{version}`	Get a specific version