GET /v1/metrics/{id}

from metadata.sdk import configure
from metadata.sdk.entities import Metrics

configure(
    host="https://your-org.getcollate.io/api",
    jwt_token="your-jwt-token"
)

# Get by ID.
metric = Metrics.retrieve("b8a9d6e4-2f7c-4f3a-9c1e-6d5b8a7f2e10")
print(f"{metric.fullyQualifiedName}: {metric.displayName}")

# Get by ID with relationship fields.
metric = Metrics.retrieve(
    "b8a9d6e4-2f7c-4f3a-9c1e-6d5b8a7f2e10",
    fields=["owners", "reviewers", "relatedMetrics", "domains", "dataProducts"]
)

# Get by fully qualified name.
metric = Metrics.retrieve_by_name(
    "customer_retention_rate",
    fields=["owners", "tags", "domains"]
)

// client is an initialized OpenMetadataClient.
var metric = client.metrics().get(
    "b8a9d6e4-2f7c-4f3a-9c1e-6d5b8a7f2e10",
    "owners,reviewers,relatedMetrics,domains,dataProducts");

var metricByName = client.metrics().getByName(
    "customer_retention_rate",
    "owners,tags,domains");

System.out.println(metricByName.getDisplayName());

# Get by ID.
curl "{base_url}/api/v1/metrics/b8a9d6e4-2f7c-4f3a-9c1e-6d5b8a7f2e10" \
  -H "Authorization: Bearer {access_token}"

# Get by ID with relationship fields.
curl "{base_url}/api/v1/metrics/b8a9d6e4-2f7c-4f3a-9c1e-6d5b8a7f2e10?fields=owners,reviewers,relatedMetrics,domains,dataProducts" \
  -H "Authorization: Bearer {access_token}"

# Get by fully qualified name.
curl "{base_url}/api/v1/metrics/name/customer_retention_rate?fields=owners,tags,domains" \
  -H "Authorization: Bearer {access_token}"

{
  "id": "b8a9d6e4-2f7c-4f3a-9c1e-6d5b8a7f2e10",
  "name": "customer_retention_rate",
  "displayName": "Customer Retention Rate",
  "fullyQualifiedName": "customer_retention_rate",
  "description": "Percentage of customers retained during the month.",
  "metricExpression": {
    "language": "SQL",
    "code": "retained_customers * 100.0 / NULLIF(total_customers, 0)"
  },
  "metricType": "RATIO",
  "unitOfMeasurement": "PERCENTAGE",
  "granularity": "MONTH",
  "version": 0.1,
  "updatedAt": 1787760000000,
  "updatedBy": "admin",
  "href": "https://your-org.getcollate.io/api/v1/metrics/b8a9d6e4-2f7c-4f3a-9c1e-6d5b8a7f2e10",
  "deleted": false,
  "owners": [],
  "reviewers": [],
  "relatedMetrics": [],
  "tags": [],
  "domains": [],
  "dataProducts": []
}

GET

metrics

{id}

GET /v1/metrics/{id}

from metadata.sdk import configure
from metadata.sdk.entities import Metrics

configure(
    host="https://your-org.getcollate.io/api",
    jwt_token="your-jwt-token"
)

# Get by ID.
metric = Metrics.retrieve("b8a9d6e4-2f7c-4f3a-9c1e-6d5b8a7f2e10")
print(f"{metric.fullyQualifiedName}: {metric.displayName}")

# Get by ID with relationship fields.
metric = Metrics.retrieve(
    "b8a9d6e4-2f7c-4f3a-9c1e-6d5b8a7f2e10",
    fields=["owners", "reviewers", "relatedMetrics", "domains", "dataProducts"]
)

# Get by fully qualified name.
metric = Metrics.retrieve_by_name(
    "customer_retention_rate",
    fields=["owners", "tags", "domains"]
)

// client is an initialized OpenMetadataClient.
var metric = client.metrics().get(
    "b8a9d6e4-2f7c-4f3a-9c1e-6d5b8a7f2e10",
    "owners,reviewers,relatedMetrics,domains,dataProducts");

var metricByName = client.metrics().getByName(
    "customer_retention_rate",
    "owners,tags,domains");

System.out.println(metricByName.getDisplayName());

# Get by ID.
curl "{base_url}/api/v1/metrics/b8a9d6e4-2f7c-4f3a-9c1e-6d5b8a7f2e10" \
  -H "Authorization: Bearer {access_token}"

# Get by ID with relationship fields.
curl "{base_url}/api/v1/metrics/b8a9d6e4-2f7c-4f3a-9c1e-6d5b8a7f2e10?fields=owners,reviewers,relatedMetrics,domains,dataProducts" \
  -H "Authorization: Bearer {access_token}"

# Get by fully qualified name.
curl "{base_url}/api/v1/metrics/name/customer_retention_rate?fields=owners,tags,domains" \
  -H "Authorization: Bearer {access_token}"

{
  "id": "b8a9d6e4-2f7c-4f3a-9c1e-6d5b8a7f2e10",
  "name": "customer_retention_rate",
  "displayName": "Customer Retention Rate",
  "fullyQualifiedName": "customer_retention_rate",
  "description": "Percentage of customers retained during the month.",
  "metricExpression": {
    "language": "SQL",
    "code": "retained_customers * 100.0 / NULLIF(total_customers, 0)"
  },
  "metricType": "RATIO",
  "unitOfMeasurement": "PERCENTAGE",
  "granularity": "MONTH",
  "version": 0.1,
  "updatedAt": 1787760000000,
  "updatedBy": "admin",
  "href": "https://your-org.getcollate.io/api/v1/metrics/b8a9d6e4-2f7c-4f3a-9c1e-6d5b8a7f2e10",
  "deleted": false,
  "owners": [],
  "reviewers": [],
  "relatedMetrics": [],
  "tags": [],
  "domains": [],
  "dataProducts": []
}

Retrieve a Metric

Get a metric by its UUID or fully qualified name. Because metrics use a global namespace, the fully qualified name is the metric name.

Get by ID

string

required

UUID of the metric to retrieve.

string

Comma-separated fields to include: owners, reviewers, relatedMetrics, followers, tags, extension, domains, and dataProducts.

string

default:"non-deleted"

Include all, deleted, or non-deleted metrics.

string

Per-relation include settings in field:value form, such as owners:non-deleted,followers:all.

Get by Fully Qualified Name

Use GET /v1/metrics/name/{fqn} to retrieve a metric by name.

string

required

Fully qualified name of the metric, such as customer_retention_rate.

The fields, include, and includeRelations query parameters are also supported by the name endpoint.

GET /v1/metrics/{id}

from metadata.sdk import configure
from metadata.sdk.entities import Metrics

configure(
    host="https://your-org.getcollate.io/api",
    jwt_token="your-jwt-token"
)

# Get by ID.
metric = Metrics.retrieve("b8a9d6e4-2f7c-4f3a-9c1e-6d5b8a7f2e10")
print(f"{metric.fullyQualifiedName}: {metric.displayName}")

# Get by ID with relationship fields.
metric = Metrics.retrieve(
    "b8a9d6e4-2f7c-4f3a-9c1e-6d5b8a7f2e10",
    fields=["owners", "reviewers", "relatedMetrics", "domains", "dataProducts"]
)

# Get by fully qualified name.
metric = Metrics.retrieve_by_name(
    "customer_retention_rate",
    fields=["owners", "tags", "domains"]
)

// client is an initialized OpenMetadataClient.
var metric = client.metrics().get(
    "b8a9d6e4-2f7c-4f3a-9c1e-6d5b8a7f2e10",
    "owners,reviewers,relatedMetrics,domains,dataProducts");

var metricByName = client.metrics().getByName(
    "customer_retention_rate",
    "owners,tags,domains");

System.out.println(metricByName.getDisplayName());

# Get by ID.
curl "{base_url}/api/v1/metrics/b8a9d6e4-2f7c-4f3a-9c1e-6d5b8a7f2e10" \
  -H "Authorization: Bearer {access_token}"

# Get by ID with relationship fields.
curl "{base_url}/api/v1/metrics/b8a9d6e4-2f7c-4f3a-9c1e-6d5b8a7f2e10?fields=owners,reviewers,relatedMetrics,domains,dataProducts" \
  -H "Authorization: Bearer {access_token}"

# Get by fully qualified name.
curl "{base_url}/api/v1/metrics/name/customer_retention_rate?fields=owners,tags,domains" \
  -H "Authorization: Bearer {access_token}"

{
  "id": "b8a9d6e4-2f7c-4f3a-9c1e-6d5b8a7f2e10",
  "name": "customer_retention_rate",
  "displayName": "Customer Retention Rate",
  "fullyQualifiedName": "customer_retention_rate",
  "description": "Percentage of customers retained during the month.",
  "metricExpression": {
    "language": "SQL",
    "code": "retained_customers * 100.0 / NULLIF(total_customers, 0)"
  },
  "metricType": "RATIO",
  "unitOfMeasurement": "PERCENTAGE",
  "granularity": "MONTH",
  "version": 0.1,
  "updatedAt": 1787760000000,
  "updatedBy": "admin",
  "href": "https://your-org.getcollate.io/api/v1/metrics/b8a9d6e4-2f7c-4f3a-9c1e-6d5b8a7f2e10",
  "deleted": false,
  "owners": [],
  "reviewers": [],
  "relatedMetrics": [],
  "tags": [],
  "domains": [],
  "dataProducts": []
}

Returns

Returns the metric with the requested fields populated.

Response

string

Unique metric identifier in UUID format.

string

Globally unique metric name.

string

Fully qualified name. For a metric, this is the same value as name.

object

Expression language and code used to calculate the metric.

string

Type of calculation represented by the metric.

string

Unit used to report the metric value.

string

Time granularity of the metric.

array

Dimensions available for grouping or slicing the metric.

array

Measures used by the metric.

array

Filters applied to the metric calculation.

array

Data assets the metric is calculated from or applies to.

array

Owners included when requested through fields.

array

Reviewers included when requested through fields.

Related metrics included when requested through fields.

array

Domain references included when requested through fields.

array

Data product references included when requested through fields.

number

Current metadata version of the metric.

Error Handling

Code	Error Type	Description
`400`	`BAD_REQUEST`	Invalid ID, field, or include value
`401`	`UNAUTHORIZED`	Invalid or missing authentication token
`403`	`FORBIDDEN`	User lacks permission to view this metric
`404`	`NOT_FOUND`	Metric with the given ID or FQN does not exist

⌘I

​Retrieve a Metric

​Get by ID

​Get by Fully Qualified Name

​Returns

​Response

​Error Handling

Retrieve a Metric

Get by ID

Get by Fully Qualified Name

Returns

Response

Error Handling