Saltar al contenido principal
GET
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
requerido

El ID del panel, un UUID.

Parámetros de consulta

version
integer | null

Una versión anterior para leer. La más reciente si se omite.

Rango requerido: x >= 1
filters[days]
integer | null

Estos últimos días completos, sin contar hoy.

Rango requerido: 1 <= x <= 3660
filters[from]
string<date> | null

El primer día de un rango fijo, como YYYY-MM-DD. Envíalo con to.

filters[to]
string<date> | null

El último día de un rango fijo, como YYYY-MM-DD. Envíalo con from.

filters[locations][]
string<uuid>[]

El ID de una ubicación que se conserva, un UUID.

filters[family]
string<uuid> | null

El ID de una familia de artículos que se conserva, un UUID.

Respuesta

DashboardDetailResource

data
DashboardDetailResource · object
requerido

Un panel con la versión leída, su historial y los valores que pueden tomar sus filtros.