Skip to main content
GET
List KPI periods

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*

Query Parameters

fromDate
string<date>
Example:

"2022-03-10"

mockMissingPeriods
boolean
default:false
toDate
string<date>
Example:

"2022-03-10"

Response

KPI periods returned

id
string
periodType
enum<string>
Available options:
DAY,
MONTH,
QUARTER,
FOUR_MONTHS,
SIX_MONTHS,
YEAR,
TWO_YEARS,
THREE_YEARS,
FIVE_YEARS,
CUSTOM
periodStartsAt
string<date>
Example:

"2022-03-10"

periodEndsAt
string<date>
Example:

"2022-03-10"

value
number
mock
boolean