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

dashboard
string | null
requerido

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

Cuerpo

application/json

Un panel para guardar, o una versión nueva de uno: sus widgets en una cuadrícula de 12 columnas y los filtros globales con los que se abre.

name
string
requerido

El nombre del panel, de hasta 120 caracteres, como se muestra en la lista de paneles.

Maximum string length: 120
widgets
object[]
requerido

Los widgets de la cuadrícula, máximo 50. Una lista vacía guarda un panel en blanco.

Maximum array length: 50
description
string | null

Para qué sirve el panel, en una oración.

Maximum string length: 1000
filters
object | null

Los filtros globales: una cantidad de días o un rango de fechas fijo, ubicaciones y una familia de artículos. Un widget cuyo conjunto de datos no admite un filtro lo omite.

restored_from
integer | null

La versión que copió una restauración, para que el historial la registre.

Rango requerido: x >= 1

Respuesta

DashboardSavedResource

data
DashboardSavedResource · object
requerido

Un panel tal como queda después de guardarlo o de un cambio de uso compartido. Lee el panel por su ID para ver el resto.