Skip to main content

CreateKpiTargetDto

metricKeystringrequired

Metric this target applies to. Must be a registered metric.

Possible values: [production.tonnage, safety.open_incidents, compliance.overdue_obligations, workforce.absenteeism_rate, finance.cost_per_tonne, finance.compensation_cost, workforce.headcount, environment.open_incidents]

scopeTypestringrequired

Possible values: [TENANT, SITE, ZONE, LEVEL, TUNNEL]

scopeIdstring

Hierarchy node the target applies to. Omit for a TENANT-wide target.

periodstringrequired

Possible values: [DAILY, WEEKLY, MONTHLY, QUARTERLY, ANNUAL]

targetValuenumberrequired

The goal for one period, in the metric’s unit.

warnAtPercentnumber

Percent of target below which the KPI is amber.

Default value: 90
breachAtPercentnumber

Percent of target below which the KPI is red and raises an alert.

Default value: 80
effectiveStartstringrequired
Example: 2026-01-01
effectiveEndstring
Example: 2026-12-31
CreateKpiTargetDto
{
  "metricKey": "production.tonnage",
  "scopeType": "TENANT",
  "scopeId": "string",
  "period": "DAILY",
  "targetValue": 0,
  "warnAtPercent": 90,
  "breachAtPercent": 80,
  "effectiveStart": "2026-01-01",
  "effectiveEnd": "2026-12-31"
}