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-10-18 18:02:22 +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` 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								## Properties
  
						 
					
						
							
								
									
										
										
										
											2021-09-19 08:43:31 +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 64
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								 -  **fullyQualifiedName**
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								   -  A unique name that identifies a metric in the format 'ServiceName.MetricName'.
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								   -  Type: `string` 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								   -  Length: between 1 and 64
							 
						 
					
						
							
								
									
										
										
										
											2021-10-14 16:19:34 +05:30 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								 -  **displayName**
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								     -  Display Name that identifies this metric.
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								     -  Type: `string` 
							 
						 
					
						
							
								
									
										
										
										
											2021-09-19 08:43:31 +05:30 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								 -  **description**
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								   -  Description of metrics instance, what it is, and how to use it.
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								   -  Type: `string` 
							 
						 
					
						
							
								
									
										
										
										
											2021-10-18 18:02:22 +05:30 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								 -  **version**
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								   -  Metadata version of the entity.
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								   -  $ref: [../../type/basic.json#/definitions/entityVersion ](../types/basic.md#entityversion )
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								 -  **updatedAt**
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								   -  Last update time corresponding to the new version of the entity.
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								   -  $ref: [../../type/basic.json#/definitions/dateTime ](../types/basic.md#datetime )
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								 -  **updatedBy**
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								   -  User who made the update.
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								   -  Type: `string` 
							 
						 
					
						
							
								
									
										
										
										
											2021-09-19 08:43:31 +05:30 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								 -  **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 )
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								 -  **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 )
							 
						 
					
						
							
								
									
										
										
										
											2021-08-13 15:48:38 +00:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
									
										
										
										
											2021-10-15 03:51:13 +05:30 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
									
										
										
										
											2021-10-18 18:02:22 +05:30 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								_This document was updated on: Monday, October 18, 2021_