mirror of
https://github.com/open-metadata/OpenMetadata.git
synced 2025-10-06 06:16:21 +00:00
35 lines
2.5 KiB
Markdown
35 lines
2.5 KiB
Markdown
|
---
|
||
|
|
title: kpi
|
||
|
|
slug: /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: `None`.
|
||
|
|
- **`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*.
|
||
|
|
- **`incrementalChangeDescription`**: 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`.
|
||
|
|
- **`domains`**: Domains the asset belongs to. When not set, the asset inherits the domain from the parent it belongs to. Refer to *../../type/entityReferenceList.json*.
|
||
|
|
|
||
|
|
|
||
|
|
Documentation file automatically generated at 2025-08-12 05:39:47.683420+00:00.
|