2021-08-11 17:17:55 +00:00
# Metrics
This schema defines the Metrics entity. 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` .
2021-11-15 21:35:54 +05:30
**$id:**[**https://open-metadata.org/schema/entity/data/metrics.json** ](https://open-metadata.org/schema/entity/data/metrics.json )
2021-08-11 17:17:55 +00:00
Type: `object`
2021-12-09 18:19:32 +05:30
This schema < u > does not< / u > accept additional properties.
2021-08-11 17:17:55 +00:00
## Properties
2022-01-25 22:19:15 +05:30
- **id** `required`
- Unique identifier that identifies this metrics instance.
- $ref: [../../type/basic.json#/definitions/uuid ](../types/basic.md#uuid )
- **name** `required`
- Name that identifies this metrics instance uniquely.
- Type: `string`
- Length: between 1 and 128
- **fullyQualifiedName**
- A unique name that identifies a metric in the format 'ServiceName.MetricName'.
- Type: `string`
- Length: between 1 and 256
- **displayName**
- Display Name that identifies this metric.
- Type: `string`
- **description**
- Description of metrics instance, what it is, and how to use it.
- Type: `string`
- **version**
- Metadata version of the entity.
- $ref: [../../type/entityHistory.json#/definitions/entityVersion ](../types/entityhistory.md#entityversion )
- **updatedAt**
- Last update time corresponding to the new version of the entity in Unix epoch time milliseconds.
- $ref: [../../type/basic.json#/definitions/timestamp ](../types/basic.md#timestamp )
- **updatedBy**
- User who made the update.
- Type: `string`
- **href**
- Link to the resource corresponding to this entity.
- $ref: [../../type/basic.json#/definitions/href ](../types/basic.md#href )
- **owner**
- Owner of this metrics.
- $ref: [../../type/entityReference.json ](../types/entityreference.md )
- **tags**
- Tags for this chart.
- Type: `array`
- **Items**
- $ref: [../../type/tagLabel.json ](../types/taglabel.md )
- **service** `required`
- Link to service where this metrics is hosted in.
- $ref: [../../type/entityReference.json ](../types/entityreference.md )
- **usageSummary**
- Latest usage information for this database.
- $ref: [../../type/usageDetails.json ](../types/usagedetails.md )
- **changeDescription**
- Change that lead to this version of the entity.
- $ref: [../../type/entityHistory.json#/definitions/changeDescription ](../types/entityhistory.md#changedescription )
- **deleted**
- When `true` indicates the entity has been soft deleted.
- Type: `boolean`
- Default: _false_
2021-08-13 15:48:38 +00:00
2022-03-08 09:23:53 +05:30
2022-03-10 12:55:35 +05:30
_This document was updated on: Wednesday, March 9, 2022_
