yujunjun/OpenMetadata
1
0
Fork 0
mirror of https://github.com/open-metadata/OpenMetadata.git synced 2025-10-24 15:25:10 +00:00
Code Issues Packages Projects Releases Wiki Activity
OpenMetadata/openmetadata-docs/content/v1.1.x/main-concepts/metadata-standard/schemas/dataInsight/kpi/basic.md
Pere Miquel Brull 3afb5212ec
[Docs] - Use a.b.x as version pattern (#13161) 
* [Docs] - Use a.b.x as version pattern

* Fix image path
2023-09-12 19:41:21 +02:00

1.3 KiB
Raw Blame History

title slug
basic /main-concepts/metadata-standard/schemas/datainsight/kpi/basic

Basic

This schema defines basic types that are used by other Kpi Definitions

Definitions

  • kpiTargetType (string): This enum defines the type of key Result. Must be one of: ['NUMBER', 'PERCENTAGE'].
  • kpiTarget (object): This schema defines the parameter values that can be passed for a Kpi Parameter. Cannot contain additional properties.
    • name (string): name of the parameter. Must match the parameter names in metrics of the chart this objective refers.
    • value (string): value to be passed for the Parameters. These are input from Users. We capture this in in string and convert during the runtime.
    • targetMet (boolean): whether the target value was met or not.
  • kpiResult (object): Schema to capture kpi result. Cannot contain additional properties.
    • timestamp: Data one which result is updated. Refer to ../../type/basic.json#/definitions/timestamp.
    • kpiFqn: KPI FQN. Refer to ../../type/basic.json#/definitions/fullyQualifiedEntityName.
    • targetResult (array): Metric and their corresponding current results.
      • Items: Refer to #/definitions/kpiTarget.

Documentation file automatically generated at 2023-07-07 05:50:35.981927.