OpenMetadata/openmetadata-docs/content/v1.9.x/main-concepts/metadata-standard/schemas/dataInsight/kpi/kpi.md

title	description	slug
KPI Schemas | OpenMetadata KPI Metrics and Schema Details	Connect Kpi to enable streamlined access, monitoring, or search of enterprise data using secure and scalable integrations.	/main-concepts/metadata-standard/schemas/datainsight/kpi/kpi

Kpi

A KIP entity defines a metric and a target.

Properties

• id: Unique identifier of this KPI Definition instance. Refer to ../../type/basic.json#/definitions/uuid.
• name: Name that identifies this KPI Definition. Refer to ../../type/basic.json#/definitions/entityName.
• displayName (string): Display Name that identifies this KPI Definition.
• fullyQualifiedName: FullyQualifiedName same as name. Refer to ../../type/basic.json#/definitions/fullyQualifiedEntityName.
• description: Description of the KpiObjective. Refer to ../../type/basic.json#/definitions/markdown.
• metricType: Refer to ./basic.json#/definitions/kpiTargetType.
• dataInsightChart: Data Insight Chart Referred by this Kpi Objective. Refer to ../../type/entityReference.json.
• targetValue (number): Metrics from the chart and the target to achieve the result.
• kpiResult: Result of the Kpi. Refer to ./basic.json#/definitions/kpiResult.
• startDate: Start Date for the KPIs. Refer to ../../type/basic.json#/definitions/timestamp.
• endDate: End Date for the KPIs. Refer to ../../type/basic.json#/definitions/timestamp.
• owners: Owners of this KPI definition. Refer to ../../type/entityReferenceList.json. Default: null.
• version: Metadata version of the entity. Refer to ../../type/entityHistory.json#/definitions/entityVersion.
• updatedAt: Last update time corresponding to the new version of the entity in Unix epoch time milliseconds. Refer to ../../type/basic.json#/definitions/timestamp.
• updatedBy (string): User who made the update.
• href: Link to the resource corresponding to this entity. Refer to ../../type/basic.json#/definitions/href.
• changeDescription: Change that lead to this version of the entity. Refer to ../../type/entityHistory.json#/definitions/changeDescription.
• deleted (boolean): When true indicates the entity has been soft deleted. Default: false.
• domain: Domain the asset belongs to. When not set, the asset inherits the domain from the parent it belongs to. Refer to ../../type/entityReference.json.

Documentation file automatically generated at 2025-01-15 09:05:41.923720+00:00.