main-concepts

No menu items for this category
OpenMetadata Documentation

CreateKpiRequest

Schema corresponding to a Kpi.

  • name: Name that identifies this Kpi. Refer to ../../../type/basic.json#/definitions/entityName.
  • displayName (string): Display Name that identifies this Kpi.
  • description: Description of the Kpi. Refer to ../../../type/basic.json#/definitions/markdown.
  • owners: Owner of this Kpi. Refer to ../../../type/entityReferenceList.json. Default: None.
  • dataInsightChart (string): Fully qualified name of the Chart this kpi refers to. Must be one of: ['percentage_of_data_asset_with_description_kpi', 'percentage_of_data_asset_with_owner_kpi', 'number_of_data_asset_with_description_kpi', 'number_of_data_asset_with_owner_kpi'].
  • 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.
  • targetValue (number): Metrics from the chart and the target to achieve the result.
  • metricType: Refer to ../../../dataInsight/kpi/basic.json#/definitions/kpiTargetType.
  • domains (array): Fully qualified names of the domains the KPI belongs to.
    • Items (string)

Documentation file automatically generated at 2025-08-12 05:39:47.683420+00:00.