Skip to main content

CreateKpiFormulaDto

keystringrequired

Name for the custom KPI. Prefixed with custom. if not already.

Example: cost_per_worker
labelstringrequired
Example: Cost per worker
expressionstringrequired

Arithmetic over registered metrics. Supports + - * / and brackets.

Example: finance.compensation_cost / workforce.headcount
unitstringrequired
Example: RWF/worker
directionstringrequired

Possible values: [HIGHER_IS_BETTER, LOWER_IS_BETTER]

descriptionstring
CreateKpiFormulaDto
{
"key": "cost_per_worker",
"label": "Cost per worker",
"expression": "finance.compensation_cost / workforce.headcount",
"unit": "RWF/worker",
"direction": "HIGHER_IS_BETTER",
"description": "string"
}