yujunjun/OpenMetadata
1
0
Fork 0
mirror of https://github.com/open-metadata/OpenMetadata.git synced 2025-07-13 12:08:47 +00:00
Code Issues Packages Projects Releases Wiki Activity
OpenMetadata/openmetadata-docs/content/v1.6.x-SNAPSHOT/main-concepts/metadata-standard/schemas/dataInsight/kpi/kpi.md
Pere Miquel Brull 60ed221cf1
DOCS - Update Version Snapshots (#17589)
2024-08-27 14:41:12 +05:30

2.2 KiB
Raw Blame History

title slug
kpi /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.
  • targetDefinition (array): Metrics from the chart and the target to achieve the result.
    • Items: Refer to ./basic.json#/definitions/kpiTarget.
  • 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.
  • owner: Owner of this KPI definition. Refer to ../../type/entityReference.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.
  • deleted (boolean): When true indicates the entity has been soft deleted. Default: False.

Documentation file automatically generated at 2023-10-27 13:55:46.343512.