tarunpandey23 69342d4783
Feat: update generate docs schema (#19372)
* Updated generate_docs_schema

* Updated generate_docs_schema

* Updated generate_docs_schema

* applied generate_docs_schema script

* Revert the changes in this file

---------

Co-authored-by: Tarun <tarun.p@deuexsolutions.com>
Co-authored-by: Prajwal214 <167504578+Prajwal214@users.noreply.github.com>
2025-01-15 17:46:55 +05:30

1.5 KiB

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, required): name of the parameter. Must match the parameter names in metrics of the chart this objective refers.
    • value (string, required): value to be passed for the Parameters. These are input from Users. We capture this 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.

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