Passer au contenu principal
GET
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
requis

L'ID du tableau de bord, un UUID.

Paramètres de requête

version
integer | null

Une version antérieure à lire. La plus récente si elle est omise.

Plage requise: x >= 1
filters[days]
integer | null

Ce nombre de jours complets les plus récents, sans compter aujourd'hui.

Plage requise: 1 <= x <= 3660
filters[from]
string<date> | null

Le premier jour d'une plage fixe, sous forme YYYY-MM-DD. Envoyez-le avec to.

filters[to]
string<date> | null

Le dernier jour d'une plage fixe, sous forme YYYY-MM-DD. Envoyez-le avec from.

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

L'ID d'un emplacement à conserver, un UUID.

filters[family]
string<uuid> | null

L'ID d'une famille d'articles à conserver, un UUID.

Réponse

DashboardDetailResource

data
DashboardDetailResource · object
requis

Un tableau de bord avec la version lue, son historique et les valeurs que ses filtres peuvent prendre.