Saltar al contenido principal
PUT
cURL

Autorizaciones

Authorization
string
header
requerido

Para tus propios scripts e integraciones de servidor a servidor. Crea una clave en la app en Configuración > Acceso > Claves de API y cópiala entonces, porque se muestra una sola vez. Envíala como Authorization: Bearer <key>. La clave actúa como el miembro que la creó, en la organización en la que se creó. Una llamada necesita el permiso del miembro y uno de los alcances de la clave, como inventory:read o sales:write. Una clave con * tiene todos los alcances.

Parámetros de ruta

kpi
string | null
requerido

El ID del KPI, un UUID. Omítelo para crear un KPI nuevo.

Cuerpo

application/json

Un KPI para guardar, o una versión nueva de uno: una medida sobre un conjunto de datos con su granularidad de tiempo, comparación, meta y umbrales.

name
string
requerido

El nombre del KPI, como se muestra en su widget.

Maximum string length: 120
definition
object
requerido

Lo que mide el KPI: el conjunto de datos, la medida, la duración del período y cuántos períodos, la comparación, la dirección, el objetivo y los umbrales.

description
string | null

Lo que mide el KPI, en una oración.

Maximum string length: 1000
starter
string | null

La clave del KPI inicial a partir del cual se creó, como fill-rate.

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

Respuesta

KpiSavedResource

data
KpiSavedResource · object
requerido

Un KPI tal como queda después de guardarlo. Lee la lista de KPI para ver el resto.