Version 3.1.23.2
Remarque :Ces documents concernent une ancienne version de l'API. La documentation de référence de l'API est également disponible pour la
dernière version (4.0.23.6)
.
Obsolète :l'API Looker 3.x est obsolète. Pour en savoir plus, consultez l'
avis d'abandon
.
Rechercher des éléments du tableau de bord
Renvoie un tableau d'objets DashboardElement 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".
Demande
GET
/dashboard_elements/search
Type de données
Description
Développer la définition de la requête HTTP...
id_tableau_de_bord
integer
Sélectionner des éléments faisant référence à un ID de tableau de bord donné
id_look
integer
Sélectionner des éléments faisant référence à un ID de look donné
title
string
Correspond au titre de l'élément
supprimée
booléen
Sélectionner les éléments du tableau de bord supprimés de façon réversible
champs
string
Champs demandés.
filtre_ou
booléen
Combiner les critères de recherche indiqués dans une expression booléenne OU
tri
string
Champs selon lesquels effectuer le tri. Champs triables: [:look_id, :dashboard_id, :delete, :title]
Réponse
200: Éléments du tableau de bord
Type de données
Description
peut
lock
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
lock
string
Corps du texte du bloc de texte en HTML
id_tableau_de_bord
string
ID du tableau de bord
modifier l'URI
lock
string
Chemin relatif de l'URI du fichier LookML pour modifier l'élément du tableau de bord (tableau de bord LookML uniquement).
id
lock
string
Identifiant unique
Développer la définition de "LookWithQuery"...
peut
lock
objet
Opérations que l'utilisateur actuel peut effectuer sur cet objet
id_métadonnées_contenu
lock
integer
ID des métadonnées de contenu
id
lock
integer
Identifiant unique
title
string
Titre du look
id_favori_contenu
lock
integer
ID du favori de contenu
créé le
lock
string
Heure de création du style.
supprimée
booléen
Indique si un style est "soft" supprimé.
supprimé_à
lock
string
Heure à laquelle le style a été supprimé.
id_supprimer
lock
integer
ID de l'utilisateur qui a supprimé le style.
description
string
Description
intégrer une URL
lock
string
Intégrer une URL
URL_Fichier_Excel
lock
string
URL du fichier Excel
nombre_favori
lock
integer
Nombre de favoris
formule_de_feuille_de_calcul_google
lock
string
Formule de la feuille de calcul Google
image_embed_url
lock
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
lock
string
Heure du dernier accès au look pour un utilisateur
Dernière mise à jour
lock
integer
ID de l'utilisateur qui a modifié l'apparence pour la dernière fois.
dernière_vue
lock
string
Heure de la dernière consultation dans l'UI Web de Looker
Développer la définition de LookModel...
id
lock
string
ID du modèle
label
lock
string
Libellé du modèle
publique
booléen
Est publique
limace publique
lock
string
Limace public
URL publique
lock
string
URL publique
id_requête
integer
ID de la requête
URL_courte
lock
string
URL courte
dossier
lock
Dossier de cette présentation
Développer la définition de FolderBase...
id_parent
string
ID du parent. Si l'ID parent est nul, il s'agit d'une entrée au niveau racine.
id
lock
string
Identifiant unique
id_métadonnées_contenu
lock
integer
ID des métadonnées de contenu
créé le
lock
string
Date et heure de création du dossier
id_créateur
lock
integer
ID utilisateur du créateur
compte_enfant
lock
integer
Nombre d'enfants
id_externe
lock
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
lock
booléen
Le dossier est un dossier d'intégration
racine_partagée_intégrée
lock
booléen
Dossier est le dossier partagé d'intégration racine
Is_embed_users_root
lock
booléen
Dossier est le dossier d'intégration racine
personnel_personnel
lock
booléen
Dossier est le dossier personnel d'un utilisateur
is_personal_descendant
lock
booléen
Le dossier est le descendant du dossier personnel d'un utilisateur
racine_partagée
lock
booléen
Dossier est le dossier partagé racine
racine_utilisateurs
lock
booléen
Dossier est le dossier utilisateur racine
peut
lock
objet
Opérations que l'utilisateur actuel peut effectuer sur cet objet
id_dossier
string
ID du dossier
mis à jour le
lock
string
Heure à laquelle le style a été mis à jour.
user_id
integer
ID utilisateur
nombre_vues
lock
integer
Nombre de vues dans l'UI Web de Looker
user
lock
(OBSOLÈTE) Utilisateur
Développer la définition "UserIdOnly"...
id
lock
integer
Identifiant unique
espace_id
string
ID de l'espace
espace
lock
Espace de ce look
Développer la définition de "SpaceBase"...
id_parent
string
ID du parent. Si l'ID parent est nul, il s'agit d'une entrée au niveau racine.
id
lock
string
Identifiant unique
id_métadonnées_contenu
lock
integer
ID des métadonnées de contenu
créé le
lock
string
Heure de création de l'espace
id_créateur
lock
integer
ID utilisateur du créateur
compte_enfant
lock
integer
Nombre d'enfants
id_externe
lock
string
ID de l'intégrateur si cet espace a été généré automatiquement en tant qu'espace partagé en intégration via "external_group_id" dans une connexion d'intégration SSO
Is_embed
lock
booléen
L'espace est un espace intégré
racine_partagée_intégrée
lock
booléen
L'espace est l'espace partagé d'intégration racine
Is_embed_users_root
lock
booléen
L'espace est la racine des utilisateurs intégrés
personnel_personnel
lock
booléen
L'espace est l'espace personnel d'un utilisateur
is_personal_descendant
lock
booléen
L'espace est un descendant de l'espace personnel d'un utilisateur
racine_partagée
lock
booléen
L'espace est l'espace partagé racine
racine_utilisateurs
lock
booléen
L'espace est l'espace utilisateur racine
peut
lock
objet
Opérations que l'utilisateur actuel peut effectuer sur cet objet
Développer la définition de la requête...
peut
lock
objet
Opérations que l'utilisateur actuel peut effectuer sur cet objet
id
lock
integer
Identifiant unique
vue
string
Explorer le nom
tableau croisé dynamique
chaîne[]
expression_de_filtre
string
Expression de filtre
limite_colonne
string
Nombre maximal de colonnes
ligne_total
string
Total brut
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
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
lock
string
Partager l'URL
URL_partage_étendu
lock
string
URL de partage agrandie
url
lock
string
URL étendue
requête_fuseau horaire
string
Requête Fuseau horaire
has_table_calculations
lock
booléen
Contient des calculs de tables
runtime
nombre
(OBSOLÈTE) Environnement d'exécution (obsolète)
id_look
string
ID de l'aspect
id_lien_lookml
lock
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
lock
string
Texte de note en HTML
Développer la définition de la requête...
peut
lock
objet
Opérations que l'utilisateur actuel peut effectuer sur cet objet
id
lock
integer
Identifiant unique
vue
string
Explorer le nom
tableau croisé dynamique
chaîne[]
expression_de_filtre
string
Expression de filtre
limite_colonne
string
Nombre maximal de colonnes
ligne_total
string
Total brut
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
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
lock
string
Partager l'URL
URL_partage_étendu
lock
string
URL de partage agrandie
url
lock
string
URL étendue
requête_fuseau horaire
string
Requête Fuseau horaire
has_table_calculations
lock
booléen
Contient des calculs de tables
runtime
nombre
(OBSOLÈTE) Environnement d'exécution (obsolète)
id_requête
integer
ID de la requête
intervalle_d'actualisation
string
Fréquence d'actualisation
actualisation_intervalle_à_i
lock
integer
Intervalle d'actualisation sous forme d'entier
résultat_créateur
Données sur le générateur de résultats.
Développer la définition de ResultMakerWithIdVisConfigAndDynamicFields...
id
lock
integer
ID unique.
champs_dynamiques
lock
string
Chaîne JSON d'informations de champ dynamique.
Développer la définition de ResultMakerFilterables...
modèle
lock
string
Modèle d'où provient ce filtre (pour les suggestions de champs).
vue
lock
string
Vue d'où provient ce filtre (utilisée pour les suggestions de champs).
name
lock
string
Nom de l'élément filtrable (requête ou résultats fusionnés).
id_fusion_résultats
lock
string
ID du résultat de la fusion s'il s'agit d'un résultat de fusion_result.
total
lock
booléen
Total de l'aspect, de la requête ou de la fusion
id_requête
lock
integer
ID de la requête s'il s'agit d'une requête.
sql_query_id (ID de requête SQL)
lock
string
ID de la requête SQL s'il s'agit d'une requête d'exécuteur SQL
Développer la définition de la requête...
peut
lock
objet
Opérations que l'utilisateur actuel peut effectuer sur cet objet
id
lock
integer
Identifiant unique
vue
string
Explorer le nom
tableau croisé dynamique
chaîne[]
expression_de_filtre
string
Expression de filtre
limite_colonne
string
Nombre maximal de colonnes
ligne_total
string
Total brut
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
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
lock
string
Partager l'URL
URL_partage_étendu
lock
string
URL de partage agrandie
url
lock
string
URL étendue
requête_fuseau horaire
string
Requête Fuseau horaire
has_table_calculations
lock
booléen
Contient des calculs de tables
runtime
nombre
(OBSOLÈTE) Environnement d'exécution (obsolète)
vis_config
lock
objet
Par rapport à la configuration de la requête de composant ou de la requête de fusion.
id_outil_résultats
integer
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
nombre_alertes
lock
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
lock
string
Texte du titre du bloc d'annonces au format HTML
subtitle_text_as_html
lock
string
Sous-titre du texte en HTML
400 Bad Request
Type de données
Description
Message
lock
string
Infos sur l'erreur
documentation_url
lock
string
Lien vers la documentation
404: introuvable
Type de données
Description
Message
lock
string
Infos sur l'erreur
documentation_url
lock
string
Lien vers la documentation