Health Metrics
Promote health metric
Promotes a health metric to a KPI while preserving resource id.
POST
Promote health metric
Authorizations
Owner-typed API key (ORGANIZATION, PERSON, VALUE_UNIT). Manage org-scoped lifecycle with /v1/public-api-keys; cross-org governance is restricted to /v1/sys/public-api-keys.
Path Parameters
Pattern:
[^\s_]\S*Body
application/json
Promote payload with KPI-specific values. Omitted fields are not allowed.
Available options:
AVERAGE, SUM, GEOMETRIC_MEAN, LAST_VALUE Available options:
BASELINE, INCREASE, DECREASE, MAINTAIN, MILESTONE, PERCENTAGE Available options:
DAY, MONTH, QUARTER, FOUR_MONTHS, SIX_MONTHS, YEAR, TWO_YEARS, THREE_YEARS, FIVE_YEARS, CUSTOM Example:
"2022-03-10"
Example:
"2022-03-10"
Available options:
NO_ZONES, TWO_ZONES_YES_NO, TWO_ZONES_YES_NO_ASPIRATIONAL, TWO_ZONES, TWO_ZONES_ASPIRATIONAL, TWO_ZONES_BEST_WORST, THREE_ZONES, THREE_ZONES_BEST_WORST, FOUR_ZONES_ASPIRATIONAL, FOUR_ZONES_SOFT_ORANGE, FOUR_ZONES_SOFT_GREEN, THREE_ZONES_MAINTAIN, FIVE_ZONES_MAINTAIN Maximum array length:
2Response
Health metric promoted to KPI
Available options:
DAY, MONTH, QUARTER, YEAR Available options:
AVERAGE, SUM, GEOMETRIC_MEAN, LAST_VALUE Available options:
BASELINE, INCREASE, DECREASE, MAINTAIN, MILESTONE, PERCENTAGE Available options:
DAY, MONTH, QUARTER, FOUR_MONTHS, SIX_MONTHS, YEAR, TWO_YEARS, THREE_YEARS, FIVE_YEARS, CUSTOM Example:
"2022-03-10"
Example:
"2022-03-10"
Available options:
NO_ZONES, TWO_ZONES_YES_NO, TWO_ZONES_YES_NO_ASPIRATIONAL, TWO_ZONES, TWO_ZONES_ASPIRATIONAL, TWO_ZONES_BEST_WORST, THREE_ZONES, THREE_ZONES_BEST_WORST, FOUR_ZONES_ASPIRATIONAL, FOUR_ZONES_SOFT_ORANGE, FOUR_ZONES_SOFT_GREEN, THREE_ZONES_MAINTAIN, FIVE_ZONES_MAINTAIN Example:
"2022-03-10T16:15:50Z"
Example:
"2022-03-10T16:15:50Z"

