Rechercher des tableaux de bord

Version 4.0.23.2

Rechercher des tableaux de bord

Renvoie un tableau d'objets de tableau de bord correspondant aux critères de recherche spécifiés.

Si plusieurs paramètres de recherche sont fournis et que filter_or est défini sur FALSE ou non spécifié, les paramètres de recherche sont combinés dans une opération logique AND. Seules les lignes correspondant à tous les critères de recherche sont renvoyées.

Si filter_or est VRAI, plusieurs paramètres de recherche sont combinés dans une opération logique OU. Les résultats comprennent les lignes qui correspondent à n'importe lequel des critères de recherche.

Les paramètres de recherche de chaîne utilisent une correspondance non sensible à la casse. Les paramètres de recherche de chaîne peuvent contenir % et '_' en tant qu'expressions génériques de correspondance de type SQL like. example="dan%" correspond à "danger" et "Danzig", mais pas "David", example="D_m%" correspond à "Damage" et "dump"

Les paramètres de recherche de nombres entiers peuvent accepter une valeur unique ou une liste de valeurs séparées par une virgule. Les différentes valeurs seront combinées sous la forme d'une opération logique OU. Les résultats correspondront à au moins une des valeurs données.

La plupart des paramètres de recherche peuvent accepter "IS NULL" et "NOT NULL" en tant qu'expressions spéciales pour faire correspondre ou exclure (respectivement) les lignes dont la colonne est nulle.

Les paramètres de recherche booléens n'acceptent que les valeurs "true" et "false".

Les paramètres limit et offset sont recommandés pour extraire des résultats sous forme de fragments de taille de page.

Obtenez un tableau de bord unique par ID avec dashboard().

Demande

GET /dashboards/search

Type de données

Description

Demande

HTTPRequest

query

Requête HTTP

Développer la définition de la requête HTTP...

string

Correspond à l'ID du tableau de bord.

limace

string

Slug du tableau de bord.

title

string

Correspond au titre du tableau de bord.

description

string

Correspond à la description du tableau de bord.

id_favori_contenu

string

Filtrez sur un identifiant de contenu favori.

id_dossier

string

Filtrez sur un espace particulier.

supprimée

string

Filtrer selon l'état de suppression des tableaux de bord.

user_id

string

Filtrez les tableaux de bord créés par un utilisateur en particulier.

nombre_vues

string

Filtrer en fonction d'une valeur particulière de view_count

id_métadonnées_contenu

string

Filtrez sur un identifiant de contenu favori.

sélectionner

booléen

Exclure les éléments qui n'existent que dans les espaces personnels autres que les utilisateurs

dernière_vue

string

Sélectionner des tableaux de bord en fonction de la date de leur dernière consultation

champs

string

Champs demandés.

page

integer

OBSOLÈTE. Utilisez plutôt la limite et le décalage. Afficher seulement la page N des résultats paginés

par_page

integer

OBSOLÈTE. Utilisez plutôt la limite et le décalage. Afficher N lignes de données par page

limite

integer

Nombre de résultats à afficher. (utilisé avec un décalage et qui est prioritaire sur la page et par_page)

offset

integer

Nombre de résultats à ignorer avant d'en renvoyer. (utilisé avec une limite et prévaut sur la page et par_page)

tri

string

Un ou plusieurs champs à trier. Champs pouvant être triés: [:title, :user_id, :id, :created_at, :space_id, :folder_id, :description, :view_count, :favorite_count, :slug, :content_favorite_id, :content_metadata_id, :delete, :delete_at, :last_viewed_at, :last_accessed_at]

filtre_ou

booléen

Combiner les critères de recherche indiqués dans une expression booléenne OU

Réponse

200: tableaux de bord

Type de données

Description

(tableau)

Tableau de bord[]

peut

objet

Opérations que l'utilisateur actuel peut effectuer sur cet objet

id_favori_contenu

string

ID du favori de contenu

id_métadonnées_contenu

string

ID des métadonnées de contenu

description

string

Description

(couche

booléen

Est masqué

string

Identifiant unique

modèle

LookModel

Modèle

Développer la définition de LookModel...

string

ID du modèle

label

string

Libellé du modèle

requête_fuseau horaire

string

Fuseau horaire dans lequel le tableau de bord s'exécutera par défaut.

en lecture seule

booléen

Est en lecture seule

intervalle_d'actualisation

string

Actualiser l'intervalle, sous la forme d'une expression de durée telle que "2 heures et 30 minutes". Un nombre sans unité de temps sera interprété comme une seconde entière.

actualisation_intervalle_à_i

integer

Intervalle d'actualisation en millisecondes

dossier

Dossier

Développer la définition de FolderBase...

name

string

Nom unique

id_parent

string

ID du parent. Si l'ID parent est nul, il s'agit d'une entrée au niveau racine.

string

Identifiant unique

id_métadonnées_contenu

string

ID des métadonnées de contenu

créé le

string

Date et heure de création du dossier

id_créateur

string

ID utilisateur du créateur

compte_enfant

integer

Nombre d'enfants

id_externe

string

ID de l'intégrateur si ce dossier a été généré automatiquement en tant que dossier partagé d'intégration via "external_group_id" dans une connexion d'intégration SSO

Is_embed

booléen

Le dossier est un dossier d'intégration

racine_partagée_intégrée

booléen

Dossier est le dossier partagé d'intégration racine

Is_embed_users_root

booléen

Dossier est le dossier d'intégration racine

personnel_personnel

booléen

Dossier est le dossier personnel d'un utilisateur

is_personal_descendant

booléen

Le dossier est le descendant du dossier personnel d'un utilisateur

racine_partagée

booléen

Dossier est le dossier partagé racine

racine_utilisateurs

booléen

Dossier est le dossier utilisateur racine

peut

objet

Opérations que l'utilisateur actuel peut effectuer sur cet objet

title

string

Titre du tableau de bord

user_id

string

ID de l'utilisateur

limace

string

Limace de métadonnées de contenu

lecteur_préféré

string

Méthode privilégiée pour l'affichage de ce tableau de bord (par exemple, tableaux de bord ou tableaux de bord suivants)

alerte_sync_avec_filtre_activé

booléen

Autorise la synchronisation des alertes avec les modifications apportées aux filtres du tableau de bord

arrière-plan

string

Couleur de l'arrière-plan

créé le

string

Heure de création du tableau de bord.

filtre croisé

booléen

Permet le filtrage croisé dans les tableaux de bord (disponible uniquement dans les tableaux de bord suivants) (version bêta)

éléments du tableau de bord

Tableau de bord[]

Développer la définition du tableau de bord...

peut

objet

Opérations que l'utilisateur actuel peut effectuer sur cet objet

Corps du texte

string

Corps du texte du bloc de texte

Corps du texte sous forme de code HTML

string

Corps du texte du bloc de texte en HTML

id_tableau_de_bord

string

ID du tableau de bord

modifier l'URI

string

Chemin relatif de l'URI du fichier LookML pour modifier l'élément du tableau de bord (tableau de bord LookML uniquement).

string

Identifiant unique

ressemblent

LookWithQuery

Look

Développer la définition de "LookWithQuery"...

peut

objet

Opérations que l'utilisateur actuel peut effectuer sur cet objet

id_métadonnées_contenu

string

ID des métadonnées de contenu

string

Identifiant unique

title

string

Titre du look

user_id

string

ID utilisateur

id_favori_contenu

string

ID du favori de contenu

créé le

string

Heure de création du style.

supprimée

booléen

Indique si un style est "soft" supprimé.

supprimé_à

string

Heure à laquelle le style a été supprimé.

id_supprimer

string

ID de l'utilisateur qui a supprimé le style.

description

string

Description

intégrer une URL

string

Intégrer une URL

URL_Fichier_Excel

string

URL du fichier Excel

nombre_favori

integer

Nombre de favoris

formule_de_feuille_de_calcul_google

string

Formule de la feuille de calcul Google

image_embed_url

string

URL d'intégration d'image

Is_run_on_load

booléen

Exécuter l'exécution de la requête avec Look Auto

dernier_accès

string

Heure du dernier accès au look pour un utilisateur

Dernière mise à jour

string

ID de l'utilisateur qui a modifié l'apparence pour la dernière fois.

dernière_vue

string

Heure de la dernière consultation dans l'UI Web de Looker

modèle

LookModel

Modèle

publique

booléen

Est publique

limace publique

string

Limace public

URL publique

string

URL publique

id_requête

string

ID de la requête

URL_courte

string

URL courte

dossier

Dossier

Dossier de cette présentation

id_dossier

string

ID du dossier

mis à jour le

string

Heure à laquelle le style a été mis à jour.

nombre_vues

integer

Nombre de vues dans l'UI Web de Looker

query

Requête

url

string

URL

id_look

string

ID de l'aspect

id_lien_lookml

string

ID de lien LookML

id_fusion_résultats

string

ID du résultat de la fusion

note_affichage

string

Affichage des notes

état de la note

string

État de la note

texte_note

string

Texte de la note

texte_note_comme_html

string

Texte de note en HTML

query

Requête

Développer la définition de la requête...

peut

objet

Opérations que l'utilisateur actuel peut effectuer sur cet objet

string

Identifiant unique

modèle

string

Modèle

vue

string

Explorer le nom

champs

chaîne[]

tableau croisé dynamique

chaîne[]

remplir_champs

chaîne[]

filtres

objet

Filtres

expression_de_filtre

string

Expression de filtre

tri

chaîne[]

limite

string

Limite

limite_colonne

string

Nombre maximal de colonnes

total

booléen

Total

ligne_total

string

Total brut

sous-totaux

chaîne[]

vis_config

objet

Propriétés de configuration de la visualisation. Ces propriétés sont généralement opaques et diffèrent en fonction du type de visualisation utilisé. Il n'existe aucun ensemble spécifié de clés. Les valeurs peuvent correspondre à n'importe quel type compatible avec JSON. Une clé "type" avec une valeur de chaîne est souvent présente et permet à Looker de déterminer la visualisation à présenter. Les visualisations ignorent les propriétés vis_config inconnues.

config_filtre

objet

Le champ filter_config représente l'état de l'interface utilisateur du filtre sur la page d'exploration pour une requête donnée. Lorsque vous exécutez une requête via l'interface utilisateur de Looker, ce paramètre est prioritaire sur les "filtres". Lorsque vous créez ou modifiez une requête existante, vous devez définir la valeur "filter_config" sur "null". Si vous définissez une autre valeur, vous risquez d'obtenir un comportement de filtrage inattendu. Le format doit être considéré comme opaque.

sections_ui_visibles

string

Sections d'interface utilisateur visibles

limace

string

Slug

champs_dynamiques

string

Champs dynamiques

client_id

string

ID client: permet de générer des URL d'exploration raccourcies. S'il est défini par le client, il doit s'agir d'une chaîne alphanumérique unique de 22 caractères. Sinon, une seule URL sera générée.

URL_partage

string

Partager l'URL

URL_partage_étendu

string

URL de partage agrandie

url

string

URL étendue

requête_fuseau horaire

string

Requête Fuseau horaire

has_table_calculations

booléen

Contient des calculs de tables

id_requête

string

ID de la requête

intervalle_d'actualisation

string

Fréquence d'actualisation

actualisation_intervalle_à_i

integer

Intervalle d'actualisation sous forme d'entier

résultat_créateur

ResultMakerWithIdVisConfigAndDynamicFields

Données sur le générateur de résultats.

Développer la définition de ResultMakerWithIdVisConfigAndDynamicFields...

string

ID unique.

champs_dynamiques

string

Chaîne JSON d'informations de champ dynamique.

filtrables

ResultMakerFilterables[]

tri

chaîne[]

id_fusion_résultats

string

ID du résultat de la fusion s'il s'agit d'un résultat de fusion_result.

total

booléen

Total de l'aspect, de la requête ou de la fusion

id_requête

string

ID de la requête s'il s'agit d'une requête.

sql_query_id (ID de requête SQL)

string

ID de la requête SQL s'il s'agit d'une requête d'exécuteur SQL

query

Requête

vis_config

objet

Par rapport à la configuration de la requête de composant ou de la requête de fusion.

id_outil_résultats

string

ID de l'entrée ResultMakerLookup.

sous-titre

string

Texte du sous-titre de la tuile

title

string

Titre de l'élément du tableau de bord

titre_masqué

booléen

Si le titre est masqué

titre_texte

string

Titre du bloc de texte

type

string

Type

nombre_alertes

integer

Nombre d'alertes associées à un élément du tableau de bord

contenu_rich_content

string

JSON avec toutes les propriétés requises pour l'éditeur enrichi et les éléments de boutons

titre_texte_comme_html

string

Texte du titre du bloc d'annonces au format HTML

subtitle_text_as_html

string

Sous-titre du texte en HTML

ID_extension

string

ID d'extension

tableaux_de_filtres

Tableau de bord de filtrage[]

Développer la définition du tableau de bord...

peut

objet

Opérations que l'utilisateur actuel peut effectuer sur cet objet

string

Identifiant unique

id_tableau_de_bord

string

ID du tableau de bord

name

string

Nom du filtre

title

string

Titre du filtre

type

string

Type de filtre : "Date", "Nombre", "Chaîne" ou "Champ"

default_value

string

Valeur par défaut du filtre

modèle

string

Modèle de filtre (obligatoire si type = champ)

exploration

string

Explorer le filtre (obligatoire si le champ correspond au type)

dimension

string

Dimension de filtre (obligatoire si type = champ)

champ

objet

Informations sur le champ

ligne

integer

Afficher l'ordre de ce filtre par rapport aux autres filtres

écoute_des_filtres

chaîne[]

autoriser_plusieurs_valeurs

booléen

Indique si le filtre autorise plusieurs valeurs de filtre (obsolètes dans la dernière version des tableaux de bord)

required

booléen

Indique si le filtre nécessite une valeur pour exécuter le tableau de bord

Configuration de l'interface utilisateur

objet

Configuration visuelle pour ce filtre. Permet de configurer la façon dont l'UI de ce filtre doit s'afficher.

tableau_de_bord

DashboardLayout[]

Développer la définition du tableau de bord...

peut

objet

Opérations que l'utilisateur actuel peut effectuer sur cet objet

string

Identifiant unique

id_tableau_de_bord

string

ID du tableau de bord

type

string

Type

actif

booléen

Actif

largeur_colonne

integer

Largeur de la colonne

largeur

integer

Largeur

supprimée

booléen

Indique si la mise en page du tableau de bord a été supprimée ou non.

titre_tableau_de_bord

string

Titre extrait du tableau de bord que cette mise en page représente.

tableau_de_calcul_des_composants

DashboardLayoutComponent[]

Développer la définition du tableau de bord...

peut

objet

Opérations que l'utilisateur actuel peut effectuer sur cet objet

string

Identifiant unique

tableau_de_bord_ID

string

ID de mise en page du tableau de bord

id_élément_tableaudebord

string

ID du tableau de bord

ligne

integer

Row

facultative

integer

Colonne

largeur

integer

Largeur

hauteur

integer

Hauteur

supprimée

booléen

Indique si le composant de mise en page du tableau de bord a été supprimé

titre_élément

string

Titre de l'élément du tableau de bord, extrait de celui-ci.

titre_élément_masqué

booléen

Indique si le titre de l'élément du tableau de bord est affiché.

type_vis

string

Type de visualisation, extrait du résultat vis_config d'une requête

supprimée

booléen

Indique si un tableau de bord est "soft" supprimé.

supprimé_à

string

Heure à laquelle le tableau de bord était "soft" supprimé.

id_supprimer

string

L'ID de l'utilisateur "soft" a supprimé le tableau de bord.

modifier l'URI

string

Chemin relatif de l'URI du fichier LookML pour modifier le tableau de bord (tableau de bord LookML uniquement).

Activer le mode plein écran

booléen

Autoriser l'affichage des visualisations en mode plein écran

nombre_favori

integer

Nombre de favoris

barre_filtres_réduite

booléen

Définit l'état par défaut de la barre de filtres sur "Réduire" ou "Ouvrir"

top_location_top

booléen

Définit l'état par défaut de l'emplacement des filtres sur "top(true)" ou "right(false)".

dernier_accès

string

Heure du dernier accès au tableau de bord

dernière_vue

string

Heure de la dernière consultation dans l'UI Web de Looker

mis à jour le

string

Heure de la dernière mise à jour du tableau de bord.

Dernière mise à jour

string

ID de l'utilisateur qui a récemment mis à jour le tableau de bord.

Dernière mise à jour

string

Nom de l'utilisateur ayant le plus récemment mis à jour le tableau de bord.

nom_utilisateur

string

Nom de l'utilisateur qui a créé le tableau de bord.

chargement_configuration

string

qui régit le chargement du tableau de bord.

id_lien_lookml

string

Lie ce tableau de bord à un tableau de bord LookML spécifique de sorte que l'appel d'une opération **sync** sur ce tableau de bord LookML mette à jour ce tableau de bord.

afficher_barre_filtres

booléen

Afficher la barre de filtres. **Remarque concernant la sécurité** : Cette propriété n'affecte que l'apparence *cosmétique* du tableau de bord, et non la possibilité pour l'utilisateur d'accéder aux données. Le fait de masquer la barre de filtres n'empêche PAS les utilisateurs de modifier les filtres par d'autres moyens. Pour savoir comment configurer des stratégies de contrôle des accès aux données sécurisées, consultez l'article [Contrôler l'accès des utilisateurs aux données](https://cloud.google.com/looker/docs/r/api/control-access).

titre_émission

booléen

Afficher le titre

id_dossier

string

ID du dossier

couleur_du_texte_du_texte

string

Couleur du texte sur les tuiles de texte

mosaïque_d'arrière-plan

string

Couleur d'arrière-plan des tuiles

mosaïque_couleur_du_tuile

string

Couleur du texte de la carte

titre_couleur

string

Couleur des titres

nombre_vues

integer

Nombre de vues dans l'UI Web de Looker

apparence

Apparence du tableau de bord

Paramètres visuels du tableau de bord uniquement applicables aux tableaux de bord à venir (version bêta)

Développer la définition du tableau de bord apparence...

marges côté page

integer

Largeur de la marge de côté (côté)

couleur_d'arrière-plan de la page

string

Couleur d'arrière-plan du tableau de bord

mosaïque_alignement_titre

string

Alignement du titre sur les vignettes du tableau de bord

espace_emplacement_entre

integer

Espace entre les tuiles

mosaïque_d'arrière-plan

string

Couleur d'arrière-plan des tuiles

mosaïque_ombre

booléen

Ombre du bloc activée/désactivée

couleur_clé

string

Couleur clé

url

string

URL relative du tableau de bord

400 Bad Request

Type de données

Description

(objet)

Erreur

Message

string

Infos sur l'erreur

documentation_url

string

Lien vers la documentation

404: introuvable

Type de données

Description

(objet)

Erreur

Message

string

Infos sur l'erreur

documentation_url

string

Lien vers la documentation

Examples

Rechercher des tableaux de bord