Search reports
Recherche et renvoie des pages de rapports à 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 rapports 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 de rapports 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 rapports archivés doivent être récupérés. La valeur par défaut est faux.
Filtrer les rapports qui font partie des unités commerciales spécifiées.
Filtrer les rapports créés après une date et une heure précises.
Filtrer les rapports créés avant une date et une heure spécifiques.
Filtrer les rapports sur le tableau de bord spécifié.
Filtrer les rapports avec les ID spécifiés.
Le nombre maximal de résultats à afficher par page. Par défaut : 25, max : 100.
Filtrer les rapports qui figurent, ou non, sur un tableau de bord. Non défini par défaut.
Filtrer pour n'afficher que les rapports favoris de l'utilisateur demandeur. Par défaut, la valeur est « false ».
Filtrer les rapports appartenant aux utilisateurs spécifiés.
Propriétés supplémentaires à inclure dans la réponse. Les valeurs valides sont : dashboardIds, permissions, balises.
Filtrer les rapports 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 rapports associés aux balises spécifiées.
Filtrer les rapports mis à jour après une date et une heure spécifiques.
Filtrer les rapports mis à jour avant une date et une heure spécifiques.
Réponse
successful operation
Un tableau d'objets de rapport.
Le nombre total de rapports 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.