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

dashboard
string | null
requis

L'ID du tableau de bord, un UUID. Omettez-le pour créer un nouveau tableau de bord.

Corps

application/json

Un tableau de bord à enregistrer, ou une nouvelle version d'un tableau de bord : ses widgets sur une grille de 12 colonnes et les filtres globaux avec lesquels il s'ouvre.

name
string
requis

Le nom du tableau de bord, d'au plus 120 caractères, tel qu'il s'affiche dans la liste des tableaux de bord.

Maximum string length: 120
widgets
object[]
requis

Les widgets de la grille, au plus 50. Une liste vide enregistre un tableau de bord vierge.

Maximum array length: 50
description
string | null

À quoi sert le tableau de bord, en une phrase.

Maximum string length: 1000
filters
object | null

Les filtres globaux : un nombre de jours ou une plage de dates fixe, des emplacements et une famille d'articles. Un widget dont le jeu de données ne peut pas accepter un filtre l'ignore.

restored_from
integer | null

La version qu'une restauration a copiée, afin que l'historique l'enregistre.

Plage requise: x >= 1

Réponse

DashboardSavedResource

data
DashboardSavedResource · object
requis

Un tableau de bord tel qu'il est après un enregistrement ou un changement de partage. Lisez le tableau de bord par son ID pour le reste.