KPI Details UUIDs
- UpdatedJan 30, 2025
- 1 minute read
- Yokohama
- Now Intelligence
Every combination of breakdowns, elements, a time series aggregation, and a domain that you specify for an indicator has a unique identifier (UUID). To understand how the KPI Details and KPI Signals applications work, you should understand how these UUIDs are constructed.
- Up to two levels of breakdown
- Element filter
- Up to two levels of breakdown element, including multiple elements per level (aggregate score)
- A time series aggregation
- Domain separation
Each combination is represented by a so-called UUID. The UUID is concatenated from the sys_IDs of the indicator and any of these specifiers, in the following order (note the semicolon before the domain id):
<indicator_sys_id>:<breakdown_sys_id>:<elements_filter_sys_id or
element_sys_ids>:<lvl-2 breakdown_sys_id>:<lvl-2 elements_filter_sys_id or
element_sys_ids>:<aggregate_sys_id>;<domain_sys_id>
All specifiers other than indicator_sys_id are optional, with one
exception: If a breakdown_sys_id is specified, so must be at least one
element_sys_id. To specify a breakdown and not specify elements, for
example to get a list of all elements, the breakdown sys_id goes in a separate parameter. For an
example, see this GET/now/pa/scorecards REST API
example. To refer to those scores
that do not match any elements of the specified breakdown, the string unmatched
goes in place of an element_sys_id.
Targets, thresholds, and other Analytics Hub and KPI Details functions apply per UUID. In other words, they apply separately to each unique combination of indicator, breakdowns, elements and element filters, time series aggregation, and domain. The KPI Signals application also monitors each fully specified indicator separately, per UUID.