Skip to main content
POST
Create organization metric template

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.

Body

application/json

Metric template creation payload

name
string
required
Maximum string length: 200
Pattern: \S
question
string
required
Maximum string length: 200
Pattern: \S
motivation
string
required
Maximum string length: 500
Pattern: \S
dataType
enum<string>
required
Available options:
NUMBER,
CURRENCY,
PERCENTAGE,
YES_NO,
TIME
decimalPlaces
integer<int32>
required
Required range: 0 <= x <= 10
dataPeriod
enum<string>
required
Available options:
DAY,
MONTH,
QUARTER,
YEAR
aggregationType
enum<string>
required
Available options:
AVERAGE,
SUM,
GEOMETRIC_MEAN,
LAST_VALUE
chartPeriod
enum<string>
required
Available options:
MONTHLY,
QUARTERLY,
YEARLY,
ALL_TIME
desiredDirection
enum<string>
required
Available options:
BASELINE,
INCREASE,
DECREASE,
MAINTAIN,
MILESTONE,
PERCENTAGE
description
string
Maximum string length: 5000
unit
object
freetextUnit
string
Maximum string length: 20
tags
string[]
Maximum array length: 5
acronym
string
Maximum string length: 10
alternativeNames
string
Maximum string length: 200
alternativeQuestions
string[]
industries
string[]
Maximum array length: 3
jobs
string[]
Maximum array length: 3
keyValueAreas
object

Response

200 - application/json

Metric template created

data
object
meta
object