Skip to main content
PUT
cURL

Authorizations

Authorization
string
header
required

For your own scripts and server-to-server integrations. Create a key in the app under Settings > Access > API keys and copy it then, because it is shown once. Send it as Authorization: Bearer <key>. The key acts as the member who made it, in the organization it was made in. A call needs the member's permission and one of the key's scopes, such as inventory:read or sales:write. A key with * has every scope.

Path Parameters

kpi
string | null
required

Body

application/json

A KPI to save, or a new version of one: a formula over a dataset with its time grain, comparison, target and thresholds.

name
string
required

What the KPI is called.

Maximum string length: 120
definition
object
required
description
string | null

What it measures, in a sentence.

Maximum string length: 1000
starter
string | null

The starter KPI it was made from, such as fill-rate.

Pattern: ^[a-z][a-z0-9-]{0,63}$

Response

KpiSavedResource

data
KpiSavedResource · object
required