Track a specific value.
KPI charts are used to display a single value, such as a count or percentage, often used to track performance indicators.
yaml
type: "io.kestra.plugin.core.dashboard.chart.KPI"Examples
Display a Success Ratio per Flow
yaml
charts:
  - id: KPI_SUCCESS_PERCENTAGE
    type: io.kestra.plugin.core.dashboard.chart.KPI # io.kestra.plugin.core.dashboard.chart.Trends
    chartOptions:
      displayName: Success Ratio
      numberType: PERCENTAGE
      width: 3
    data:
      type: io.kestra.plugin.core.dashboard.data.ExecutionsKPI # io.kestra.plugin.core.dashboard.data.ExecutionsTrends
      columns:
        field: FLOW_ID
        agg: COUNT
      numerator:
        - field: STATE
          type: IN
          values:
            - SUCCESS
      where: # optional if you filter by namespace
        - field: NAMESPACE
          type: EQUAL_TO
          value: "company.team"
Properties
data *RequiredNon-dynamicDataFilterKPI
id *RequiredNon-dynamicstring
 Validation RegExp 
^[a-zA-Z0-9][a-zA-Z0-9_-]* Min length 
1chartOptions Non-dynamicKpiOption
Definitions
io.kestra.plugin.core.dashboard.chart.kpis.KpiOption
displayName *Requiredstring
 Min length 
1description string
numberType string
 Default 
FLAT Possible Values 
FLATPERCENTAGEwidth integer
 Default 
6 Minimum 
 >= 1 Maximum 
 <= 12GREATER_THAN_OR_EQUAL_TO
type *Requiredobject
value *Requirednumberstring
field string
labelKey string
NOT_EQUAL_TO
type *Requiredobject
value *Requirednumberstring
field string
labelKey string
OR
type *Requiredobject
values *RequiredContainsEndsWithEqualToGreaterThanGreaterThanOrEqualToInIsFalseIsNotNullIsNullIsTrueLessThanLessThanOrEqualToNotEqualToNotInOrRegexStartsWith
 Min items 
1field string
labelKey string
CONTAINS
type *Requiredobject
value *Requirednumberstring
field string
labelKey string
io.kestra.core.models.dashboards.ColumnDescriptor
agg string
 Possible Values 
AVGMAXMINSUMCOUNTdisplayName string
field string
labelKey string
EQUAL_TO
type *Requiredobject
value *Requirednumberstring
field string
labelKey string
LESS_THAN
type *Requiredobject
value *Requirednumberstring
field string
labelKey string
IS_NULL
type *Requiredobject
field string
labelKey string
IS_TRUE
type *Requiredobject
field string
labelKey string
LESS_THAN_OR_EQUAL_TO
type *Requiredobject
value *Requirednumberstring
field string
labelKey string
IN
type *Requiredobject
values *Requiredarray
 Min items 
1field string
labelKey string
io.kestra.core.models.dashboards.DataFilterKPI
type *Requiredobject
columns ColumnDescriptor
STARTS_WITH
type *Requiredobject
value *Requiredstring
field string
labelKey string
REGEX
type *Requiredobject
value *Requiredstring
field string
labelKey string
ENDS_WITH
type *Requiredobject
value *Requiredstring
field string
labelKey string
NOT_IN
type *Requiredobject
values *Requiredarray
 Min items 
1