
KPI
Track a specific value.
KPI
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"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-dynamic
Definitions
io.kestra.core.models.dashboards.DataFilterKPI
type*Requiredobject
columns
io.kestra.core.models.dashboards.ColumnDescriptor
aggstring
Possible Values
AVGMAXMINSUMCOUNTdisplayNamestring
fieldstring
labelKeystring
numerator
CONTAINS
field*Requiredstring
type*Requiredobject
value*Requirednumberstring
labelKeystring
ENDS_WITH
field*Requiredstring
type*Requiredobject
value*Requiredstring
labelKeystring
EQUAL_TO
field*Requiredstring
type*Requiredobject
value*Requirednumberstring
labelKeystring
GREATER_THAN
field*Requiredstring
type*Requiredobject
value*Requirednumberstring
labelKeystring
GREATER_THAN_OR_EQUAL_TO
field*Requiredstring
type*Requiredobject
value*Requirednumberstring
labelKeystring
IN
field*Requiredstring
type*Requiredobject
values*Requiredarray
Min items
1labelKeystring
IS_FALSE
field*Requiredstring
type*Requiredobject
labelKeystring
IS_NOT_NULL
field*Requiredstring
type*Requiredobject
labelKeystring
IS_NULL
field*Requiredstring
type*Requiredobject
labelKeystring
IS_TRUE
field*Requiredstring
type*Requiredobject
labelKeystring
LESS_THAN
field*Requiredstring
type*Requiredobject
value*Requirednumberstring
labelKeystring
LESS_THAN_OR_EQUAL_TO
field*Requiredstring
type*Requiredobject
value*Requirednumberstring
labelKeystring
NOT_EQUAL_TO
field*Requiredstring
type*Requiredobject
value*Requirednumberstring
labelKeystring
NOT_IN
field*Requiredstring
type*Requiredobject
values*Requiredarray
Min items
1labelKeystring
OR
field*Requiredstring
type*Requiredobject
values*Required
Min items
1CONTAINS
field*Requiredstring
type*Requiredobject
value*Requirednumberstring
labelKeystring
ENDS_WITH
field*Requiredstring
type*Requiredobject
value*Requiredstring
labelKeystring
EQUAL_TO
field*Requiredstring
type*Requiredobject
value*Requirednumberstring
labelKeystring
GREATER_THAN
field*Requiredstring
type*Requiredobject
value*Requirednumberstring
labelKeystring
GREATER_THAN_OR_EQUAL_TO
field*Requiredstring
type*Requiredobject
value*Requirednumberstring
labelKeystring
IN
field*Requiredstring
type*Requiredobject
values*Requiredarray
Min items
1labelKeystring
IS_FALSE
field*Requiredstring
type*Requiredobject
labelKeystring
IS_NOT_NULL
field*Requiredstring
type*Requiredobject
labelKeystring
IS_NULL
field*Requiredstring
type*Requiredobject
labelKeystring
IS_TRUE
field*Requiredstring
type*Requiredobject
labelKeystring
LESS_THAN
field*Requiredstring
type*Requiredobject
value*Requirednumberstring
labelKeystring
LESS_THAN_OR_EQUAL_TO
field*Requiredstring
type*Requiredobject
value*Requirednumberstring
labelKeystring
NOT_EQUAL_TO
field*Requiredstring
type*Requiredobject
value*Requirednumberstring
labelKeystring
NOT_IN
field*Requiredstring
type*Requiredobject
values*Requiredarray
Min items
1labelKeystring
OR
field*Requiredstring
type*Requiredobject
values*Required
Min items
1labelKeystring
REGEX
field*Requiredstring
type*Requiredobject
value*Requiredstring
labelKeystring
STARTS_WITH
field*Requiredstring
type*Requiredobject
value*Requiredstring
labelKeystring
labelKeystring
REGEX
field*Requiredstring
type*Requiredobject
value*Requiredstring
labelKeystring
STARTS_WITH
field*Requiredstring
type*Requiredobject
value*Requiredstring
labelKeystring
where
CONTAINS
field*Requiredstring
type*Requiredobject
value*Requirednumberstring
labelKeystring
ENDS_WITH
field*Requiredstring
type*Requiredobject
value*Requiredstring
labelKeystring
EQUAL_TO
field*Requiredstring
type*Requiredobject
value*Requirednumberstring
labelKeystring
GREATER_THAN
field*Requiredstring
type*Requiredobject
value*Requirednumberstring
labelKeystring
GREATER_THAN_OR_EQUAL_TO
field*Requiredstring
type*Requiredobject
value*Requirednumberstring
labelKeystring
IN
field*Requiredstring
type*Requiredobject
values*Requiredarray
Min items
1labelKeystring
IS_FALSE
field*Requiredstring
type*Requiredobject
labelKeystring
IS_NOT_NULL
field*Requiredstring
type*Requiredobject
labelKeystring
IS_NULL
field*Requiredstring
type*Requiredobject
labelKeystring
IS_TRUE
field*Requiredstring
type*Requiredobject
labelKeystring
LESS_THAN
field*Requiredstring
type*Requiredobject
value*Requirednumberstring
labelKeystring
LESS_THAN_OR_EQUAL_TO
field*Requiredstring
type*Requiredobject
value*Requirednumberstring
labelKeystring
NOT_EQUAL_TO
field*Requiredstring
type*Requiredobject
value*Requirednumberstring
labelKeystring
NOT_IN
field*Requiredstring
type*Requiredobject
values*Requiredarray
Min items
1labelKeystring
OR
field*Requiredstring
type*Requiredobject
values*Required
Min items
1CONTAINS
field*Requiredstring
type*Requiredobject
value*Requirednumberstring
labelKeystring
ENDS_WITH
field*Requiredstring
type*Requiredobject
value*Requiredstring
labelKeystring
EQUAL_TO
field*Requiredstring
type*Requiredobject
value*Requirednumberstring
labelKeystring
GREATER_THAN
field*Requiredstring
type*Requiredobject
value*Requirednumberstring
labelKeystring
GREATER_THAN_OR_EQUAL_TO
field*Requiredstring
type*Requiredobject
value*Requirednumberstring
labelKeystring
IN
field*Requiredstring
type*Requiredobject
values*Requiredarray
Min items
1labelKeystring
IS_FALSE
field*Requiredstring
type*Requiredobject
labelKeystring
IS_NOT_NULL
field*Requiredstring
type*Requiredobject
labelKeystring
IS_NULL
field*Requiredstring
type*Requiredobject
labelKeystring
IS_TRUE
field*Requiredstring
type*Requiredobject
labelKeystring
LESS_THAN
field*Requiredstring
type*Requiredobject
value*Requirednumberstring
labelKeystring
LESS_THAN_OR_EQUAL_TO
field*Requiredstring
type*Requiredobject
value*Requirednumberstring
labelKeystring
NOT_EQUAL_TO
field*Requiredstring
type*Requiredobject
value*Requirednumberstring
labelKeystring
NOT_IN
field*Requiredstring
type*Requiredobject
values*Requiredarray
Min items
1labelKeystring
OR
field*Requiredstring
type*Requiredobject
values*Required
Min items
1labelKeystring
REGEX
field*Requiredstring
type*Requiredobject
value*Requiredstring
labelKeystring
STARTS_WITH
field*Requiredstring
type*Requiredobject
value*Requiredstring
labelKeystring
labelKeystring
REGEX
field*Requiredstring
type*Requiredobject
value*Requiredstring
labelKeystring
STARTS_WITH
field*Requiredstring
type*Requiredobject
value*Requiredstring
labelKeystring
id*RequiredNon-dynamicstring
Validation RegExp
^[a-zA-Z0-9][a-zA-Z0-9_-]*Min length
1chartOptionsNon-dynamic
Definitions
io.kestra.plugin.core.dashboard.chart.kpis.KpiOption
displayName*Requiredstring
Min length
1descriptionstring
numberTypestring
Default
FLATPossible Values
FLATPERCENTAGEwidthinteger
Default
6Minimum
>= 1Maximum
<= 12