Passer au contenu principal
PUT
cURL

Autorisations

Authorization
string
header
requis

Pour vos propres scripts et vos intégrations de serveur à serveur. Créez une clé dans l'application sous Paramètres > Accès > Clés d'API et copiez-la à ce moment-là, car elle n'est affichée qu'une fois. Envoyez-la sous la forme Authorization: Bearer <key>. La clé agit en tant que le membre qui l'a créée, dans l'organisation où elle a été créée. Un appel exige l'autorisation du membre et l'une des portées de la clé, comme inventory:read ou sales:write. Une clé avec * a toutes les portées.

Paramètres de chemin

kpi
string | null
requis

L'ID de l'indicateur clé, un UUID. Omettez-le pour créer un nouvel indicateur clé.

Corps

application/json

Un KPI à enregistrer, ou une nouvelle version d'un KPI : une mesure sur un jeu de données avec sa granularité temporelle, sa comparaison, sa cible et ses seuils.

name
string
requis

Le nom de l'indicateur clé, tel qu'affiché sur son widget.

Maximum string length: 120
definition
object
requis

Ce que mesure l'indicateur clé : le jeu de données, la mesure, la durée de la période et le nombre de périodes, la comparaison, la direction, la cible et les seuils.

description
string | null

Ce que mesure l'indicateur clé, en une phrase.

Maximum string length: 1000
starter
string | null

La clé de l'indicateur clé de départ à partir duquel il a été créé, comme fill-rate.

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

Réponse

KpiSavedResource

data
KpiSavedResource · object
requis

Un KPI tel qu'il est après un enregistrement. Consultez la liste des KPI pour le reste.