KPIKPI
KPICertified

Track a specific value.

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"

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
Definitions
type*Requiredobject
columns
aggstring
Possible Values
AVGMAXMINSUMCOUNT
displayNamestring
fieldstring
labelKeystring
numerator
field*Requiredstring
type*Requiredobject
value*Requirednumberstring
labelKeystring
field*Requiredstring
type*Requiredobject
value*Requiredstring
labelKeystring
field*Requiredstring
type*Requiredobject
value*Requirednumberstring
labelKeystring
field*Requiredstring
type*Requiredobject
value*Requirednumberstring
labelKeystring
field*Requiredstring
type*Requiredobject
value*Requirednumberstring
labelKeystring
field*Requiredstring
type*Requiredobject
values*Requiredarray
Min items1
labelKeystring
field*Requiredstring
type*Requiredobject
labelKeystring
field*Requiredstring
type*Requiredobject
labelKeystring
field*Requiredstring
type*Requiredobject
labelKeystring
field*Requiredstring
type*Requiredobject
labelKeystring
field*Requiredstring
type*Requiredobject
value*Requirednumberstring
labelKeystring
field*Requiredstring
type*Requiredobject
value*Requirednumberstring
labelKeystring
field*Requiredstring
type*Requiredobject
value*Requirednumberstring
labelKeystring
field*Requiredstring
type*Requiredobject
values*Requiredarray
Min items1
labelKeystring
field*Requiredstring
type*Requiredobject
values*Required
Min items1
field*Requiredstring
type*Requiredobject
value*Requirednumberstring
labelKeystring
field*Requiredstring
type*Requiredobject
value*Requiredstring
labelKeystring
field*Requiredstring
type*Requiredobject
value*Requirednumberstring
labelKeystring
field*Requiredstring
type*Requiredobject
value*Requirednumberstring
labelKeystring
field*Requiredstring
type*Requiredobject
value*Requirednumberstring
labelKeystring
field*Requiredstring
type*Requiredobject
values*Requiredarray
Min items1
labelKeystring
field*Requiredstring
type*Requiredobject
labelKeystring
field*Requiredstring
type*Requiredobject
labelKeystring
field*Requiredstring
type*Requiredobject
labelKeystring
field*Requiredstring
type*Requiredobject
labelKeystring
field*Requiredstring
type*Requiredobject
value*Requirednumberstring
labelKeystring
field*Requiredstring
type*Requiredobject
value*Requirednumberstring
labelKeystring
field*Requiredstring
type*Requiredobject
value*Requirednumberstring
labelKeystring
field*Requiredstring
type*Requiredobject
values*Requiredarray
Min items1
labelKeystring
field*Requiredstring
type*Requiredobject
values*Required
Min items1
labelKeystring
field*Requiredstring
type*Requiredobject
value*Requiredstring
labelKeystring
field*Requiredstring
type*Requiredobject
value*Requiredstring
labelKeystring
labelKeystring
field*Requiredstring
type*Requiredobject
value*Requiredstring
labelKeystring
field*Requiredstring
type*Requiredobject
value*Requiredstring
labelKeystring
where
field*Requiredstring
type*Requiredobject
value*Requirednumberstring
labelKeystring
field*Requiredstring
type*Requiredobject
value*Requiredstring
labelKeystring
field*Requiredstring
type*Requiredobject
value*Requirednumberstring
labelKeystring
field*Requiredstring
type*Requiredobject
value*Requirednumberstring
labelKeystring
field*Requiredstring
type*Requiredobject
value*Requirednumberstring
labelKeystring
field*Requiredstring
type*Requiredobject
values*Requiredarray
Min items1
labelKeystring
field*Requiredstring
type*Requiredobject
labelKeystring
field*Requiredstring
type*Requiredobject
labelKeystring
field*Requiredstring
type*Requiredobject
labelKeystring
field*Requiredstring
type*Requiredobject
labelKeystring
field*Requiredstring
type*Requiredobject
value*Requirednumberstring
labelKeystring
field*Requiredstring
type*Requiredobject
value*Requirednumberstring
labelKeystring
field*Requiredstring
type*Requiredobject
value*Requirednumberstring
labelKeystring
field*Requiredstring
type*Requiredobject
values*Requiredarray
Min items1
labelKeystring
field*Requiredstring
type*Requiredobject
values*Required
Min items1
field*Requiredstring
type*Requiredobject
value*Requirednumberstring
labelKeystring
field*Requiredstring
type*Requiredobject
value*Requiredstring
labelKeystring
field*Requiredstring
type*Requiredobject
value*Requirednumberstring
labelKeystring
field*Requiredstring
type*Requiredobject
value*Requirednumberstring
labelKeystring
field*Requiredstring
type*Requiredobject
value*Requirednumberstring
labelKeystring
field*Requiredstring
type*Requiredobject
values*Requiredarray
Min items1
labelKeystring
field*Requiredstring
type*Requiredobject
labelKeystring
field*Requiredstring
type*Requiredobject
labelKeystring
field*Requiredstring
type*Requiredobject
labelKeystring
field*Requiredstring
type*Requiredobject
labelKeystring
field*Requiredstring
type*Requiredobject
value*Requirednumberstring
labelKeystring
field*Requiredstring
type*Requiredobject
value*Requirednumberstring
labelKeystring
field*Requiredstring
type*Requiredobject
value*Requirednumberstring
labelKeystring
field*Requiredstring
type*Requiredobject
values*Requiredarray
Min items1
labelKeystring
field*Requiredstring
type*Requiredobject
values*Required
Min items1
labelKeystring
field*Requiredstring
type*Requiredobject
value*Requiredstring
labelKeystring
field*Requiredstring
type*Requiredobject
value*Requiredstring
labelKeystring
labelKeystring
field*Requiredstring
type*Requiredobject
value*Requiredstring
labelKeystring
field*Requiredstring
type*Requiredobject
value*Requiredstring
labelKeystring
Validation RegExp^[a-zA-Z0-9][a-zA-Z0-9_-]*
Min length1
Definitions
displayName*Requiredstring
Min length1
descriptionstring
numberTypestring
DefaultFLAT
Possible Values
FLATPERCENTAGE
widthinteger
Default6
Minimum>= 1
Maximum<= 12