Skip to main content
GET
Obtenir le tableau de bord

Supported products

Autorisations

Authorization
string
header
requis

The access token received from the authorization server in the OAuth 2.0 flow.

Paramètres de chemin

dashboardId
integer<int64>
requis

L'ID du tableau de bord à récupérer.

Paramètres de requête

archived
boolean
défaut:false

Indique s'il faut récupérer un tableau de bord archivé au lieu d'un tableau de bord actif. La valeur par défaut est faux.

properties
string[]

Propriétés supplémentaires à inclure dans la réponse. Les valeurs valides sont : permissions, balises, widgets, widgets.report.

Réponse

successful operation

archived
boolean
requis

Indique si le tableau de bord est archivé.

businessUnitId
string
requis

ID de l'unité commerciale à laquelle le tableau de bord est associé.

createdAt
string<date-time>
requis

La date et l'heure de création du tableau de bord, au format ISO 8601.

id
string
requis

L'ID du tableau de bord.

name
string
requis

Nom du tableau de bord.

updatedAt
string<date-time>
requis

La date et l'heure de la dernière mise à jour du tableau de bord, au format ISO 8601.

archivedAt
string<date-time>

Si le tableau de bord est archivé, la date et l'heure de son archivage, au format ISO 8601. Absent si le tableau de bord n'est pas archivé.

createdByUserId
string

L'ID de l'utilisateur qui a créé le tableau de bord. Peut être absent.

description
string

Description du tableau de bord. Peut être absente.

lastViewedAt
string<date-time>

La date et l'heure de la dernière consultation du tableau de bord, au format ISO 8601. Absent s'il n'a pas encore été consulté.

lastViewedByUserId
string

L'ID de l'utilisateur qui a consulté le tableau de bord en dernier. Absent s'il n'a pas encore été consulté.

ownerUserId
string

L'identifiant de l'utilisateur propriétaire du tableau de bord. Absent si le tableau de bord n'a actuellement pas de propriétaire.

permissions
object
tags
object[]

Tableau d'objets représentant les balises associées au tableau de bord.

Pour les points de terminaison GET, le retour n’est effectué que lorsqu'il est demandé en incluant le champ balises dans le paramètre de requête properties. Pour les autres points de terminaison, le retour est effectué le cas échéant.

updatedByUserId
string

L'ID de l'utilisateur qui a mis à jour le tableau de bord en dernier. Peut être absent.

widgets
object[]

Un tableau d'objets représentant les widgets du tableau de bord.

Pour les points de terminaison GET, le retour n’est effectué que lorsque le champ widgets est inclus dans le paramètre de requête properties. Pour les autres points de terminaison, le retour est effectué le cas échéant.

Dernière modification le 6 octobre 2026