mirror of
https://github.com/open-metadata/OpenMetadata.git
synced 2025-07-12 19:48:26 +00:00
31 lines
2.4 KiB
Markdown
31 lines
2.4 KiB
Markdown
|
---
|
||
|
|
title: createMetric
|
||
|
|
slug: /main-concepts/metadata-standard/schemas/api/data/createmetric
|
||
|
|
---
|
||
|
|
|
||
|
|
# CreateMetricRequest
|
||
|
|
|
||
|
|
*Create Metric entity request*
|
||
|
|
|
||
|
|
## Properties
|
||
|
|
|
||
|
|
- **`name`**: Name that identifies this metric. Refer to *[../../type/basic.json#/definitions/entityName](#/../type/basic.json#/definitions/entityName)*.
|
||
|
|
- **`displayName`** *(string)*: Display Name that identifies this metric.
|
||
|
|
- **`description`**: Description of the metric instance. Refer to *[../../type/basic.json#/definitions/markdown](#/../type/basic.json#/definitions/markdown)*.
|
||
|
|
- **`metricExpression`**: Expression used to compute the metric. Refer to *[../../entity/data/metric.json#/definitions/metricExpression](#/../entity/data/metric.json#/definitions/metricExpression)*.
|
||
|
|
- **`metricType`**: Type of the metric. Refer to *[../../entity/data/metric.json#/definitions/metricType](#/../entity/data/metric.json#/definitions/metricType)*.
|
||
|
|
- **`unitOfMeasurement`**: Unit of measurement for the metric. Refer to *[../../entity/data/metric.json#/definitions/unitOfMeasurement](#/../entity/data/metric.json#/definitions/unitOfMeasurement)*.
|
||
|
|
- **`granularity`**: Metric's granularity. Refer to *[../../entity/data/metric.json#/definitions/metricGranularity](#/../entity/data/metric.json#/definitions/metricGranularity)*.
|
||
|
|
- **`relatedMetrics`** *(array)*: Other array of related metric fully qualified names that are related to this Metric.
|
||
|
|
- **Items**: Refer to *[../../type/basic.json#/definitions/fullyQualifiedEntityName](#/../type/basic.json#/definitions/fullyQualifiedEntityName)*.
|
||
|
|
- **`owners`**: Owners of this metric. Refer to *[../../type/entityReferenceList.json](#/../type/entityReferenceList.json)*. Default: `null`.
|
||
|
|
- **`tags`** *(array)*: Tags for this metric. Default: `null`.
|
||
|
|
- **Items**: Refer to *[../../type/tagLabel.json](#/../type/tagLabel.json)*.
|
||
|
|
- **`domain`** *(string)*: Fully qualified name of the domain the Metric belongs to.
|
||
|
|
- **`dataProducts`** *(array)*: List of fully qualified names of data products this entity is part of.
|
||
|
|
- **Items**: Refer to *[../../type/basic.json#/definitions/fullyQualifiedEntityName](#/../type/basic.json#/definitions/fullyQualifiedEntityName)*.
|
||
|
|
- **`extension`**: Entity extension data with custom attributes added to the entity. Refer to *[../../type/basic.json#/definitions/entityExtension](#/../type/basic.json#/definitions/entityExtension)*.
|
||
|
|
|
||
|
|
|
||
|
|
Documentation file automatically generated at 2025-01-15 09:05:41.923720+00:00.
|