Search dashboards
Recherche et renvoie des pages de tableaux de bord à l’aide de divers filtres. La recherche est éventuellement cohérente ; les modifications apportées aux tableaux de bord peuvent prendre quelques secondes avant de se refléter dans les résultats de recherche.
Prend également en charge la récupération de pages de tableaux de bord archivés ; cependant, les restrictions suivantes s’appliquent : seuls les paramètres limit et after sont respectés, tous les autres sont ignorés ; la récupération des tableaux de bord archivés ne prend pas en charge le filtrage, le tri personnalisé ou la projection de propriétés. Les résultats sont toujours renvoyés dans l’ordre du plus récemment supprimé au moins récemment supprimé.
Supported products
Supported products
Required Scopes
Required Scopes
Autorisations
The access token received from the authorization server in the OAuth 2.0 flow.
Paramètres de requête
Un jeton de curseur pour la pagination. Utilisez la valeur du champ paging.next.after de la réponse précédente.
Indique si seuls les tableaux de bord archivés doivent être récupérés. La valeur par défaut est false.
Filtrer les tableaux de bord qui font partie des unités commerciales spécifiées.
Filtrer les tableaux de bord créés après la date et l'heure spécifiées.
Filtrer les tableaux de bord créés avant la date et l'heure spécifiées.
Filtrer les tableaux de bord avec les ID spécifiés.
Le nombre maximal de résultats à afficher par page. Par défaut 25, maximum 100.
Filtrer pour n'afficher que les tableaux de bord favoris de l'utilisateur demandeur. Par défaut, la valeur est false.
Filtrer les tableaux de bord appartenant aux utilisateurs spécifiés.
Propriétés supplémentaires à inclure dans la réponse. Les valeurs valides sont : permissions, balises, widgets, widgets.report.
Filtrer les tableaux de bord dont le nom ou la description contient la chaîne de recherche.
Champ de tri et direction. Les champs pris en charge sont « name », « updatedAt » et « lastViewedAt ». La valeur par défaut est « -updatedAt ».
Filtrer les tableaux de bord associés aux balises spécifiées.
Filtrer les tableaux de bord mis à jour après la date et l'heure spécifiées.
Filtrer les tableaux de bord mis à jour avant la date et l'heure spécifiées.
Réponse
successful operation
Un tableau d'objets de tableaux de bord.
Le nombre total de tableaux de bord disponibles.
Représente les informations de pagination pour naviguer dans une liste de résultats de l'API. Il fournit des détails sur la manière d'accéder à l'ensemble de résultats précédent ou suivant.