Skip to main content
GET
Read KPI

Authorizations

X-API-Key
string
header
required

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

id
string
required
Pattern: [^\s_]\S*

Response

KPI returned

id
string
metricId
string
metricName
string
templateId
string
unitId
string
dataPeriod
enum<string>
Available options:
DAY,
MONTH,
QUARTER,
YEAR
aggregationType
enum<string>
Available options:
AVERAGE,
SUM,
GEOMETRIC_MEAN,
LAST_VALUE
criteriaType
enum<string>
Available options:
BASELINE,
INCREASE,
DECREASE,
MAINTAIN,
MILESTONE,
PERCENTAGE
initialValue
number
targetValue
number
endingPeriodType
enum<string>
Available options:
DAY,
MONTH,
QUARTER,
FOUR_MONTHS,
SIX_MONTHS,
YEAR,
TWO_YEARS,
THREE_YEARS,
FIVE_YEARS,
CUSTOM
endingPeriodStartsAt
string<date>
Example:

"2022-03-10"

endingPeriodEndsAt
string<date>
Example:

"2022-03-10"

scoringType
enum<string>
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
scoringThresholds
number[]
caretakerIds
string[]
keyResultId
string
creationTimestamp
string<date-time>
Example:

"2022-03-10T16:15:50Z"

updatedAt
string<date-time>
Example:

"2022-03-10T16:15:50Z"