Exécuter une requête encodée dans une URL

Version 3.1.23.6

Exécutez une requête encodée au format URL.

Pour ce faire, l'appelant doit encoder les spécificateurs de la requête dans la partie de la requête d'URL à l'aide d'une syntaxe spécifique à Looker, comme expliqué ci-dessous.

En règle générale, vous devez utiliser l'une des méthodes qui utilisent les paramètres au format JSON dans le corps de la requête POST pour créer et/ou exécuter des requêtes. Cette méthode existe dans les cas où il faut vraiment encoder les paramètres dans l'URL d'une seule requête "GET". Cela correspond à la façon dont l'interface utilisateur de Looker formate les URL d'exploration, etc.

Les paramètres sont très semblables au format JSON du corps, à ceci près que la syntaxe du filtre est complexe. Malheureusement, ce format ne permet pas d'appeler cette méthode via le bouton "Essayer" sur cette page de documentation. Toutefois, cela est possible lorsque vous créez des URL manuellement ou lorsque vous utilisez le SDK Looker.

Voici un exemple d'URL de requête intégrée:

https://looker.mycompany.com:19999/api/3.0/queries/models/thelook/views/inventory_items/run/json?fields=category.name,inventory_items.days_in_inventory_tier,products.count&f[category.name]=socks&sorts=products.count+desc+0&limit=500&query_timezone=America/Los_Angeles

Lorsque vous appelez ce point de terminaison avec le SDK Ruby, transmettez les parties des paramètres de requête en tant que hachage. Le hachage pour la correspondance ci-dessus se présente comme suit:

query_params =
{
  fields: "category.name,inventory_items.days_in_inventory_tier,products.count",
  :"f[category.name]" => "socks",
  sorts: "products.count desc 0",
  limit: "500",
  query_timezone: "America/Los_Angeles"
}
response = ruby_sdk.run_url_encoded_query('thelook','inventory_items','json', query_params)

Là encore, il est généralement plus facile d'utiliser la variante de cette méthode qui transmet la requête complète dans le corps de la requête POST. Cette méthode est disponible dans les cas où d'autres alternatives ne répondent pas aux besoins.

Formats compatibles :

format_résultats Description
json JSON brut
détail_json Données de ligne et métadonnées décrivant les champs, les tableaux croisés dynamiques, les valeurs de calcul de tableau et d'autres aspects de la requête
csv Valeurs séparées par une virgule avec un en-tête
txt Valeurs séparées par des tabulations, avec un en-tête
html HTML simple
md Markdown simple
xlsx Feuille de calcul MS Excel
sql Renvoie le code SQL généré au lieu d'exécuter la requête.
png Image PNG de la visualisation de la requête
jpg Image JPG de la visualisation de la requête

Demande

GET /queries/models/{model_name}/views/{view_name}/run/{result_format}
Type de données
Description
Demande
HTTPRequest
chemin d'accès
Chemin HTTP
Développer la définition HTTPPath...
model_name
string
Nom du modèle
nom_vue
string
Nom de la vue
format_résultats
string
Format du résultat

Réponse

200: Requête

Type de données
Description
(chaîne)
string

400 Bad Request

Type de données
Description
(objet)
Message
string
Infos sur l'erreur
documentation_url
string
Lien vers la documentation

404: introuvable

Type de données
Description
(objet)
Message
string
Infos sur l'erreur
documentation_url
string
Lien vers la documentation

422: Erreur de validation

Type de données
Description
(objet)
Message
string
Infos sur l'erreur
Développer la définition de ValidationErrorDetail...
champ
string
Champ comportant une erreur
code
string
Code d'erreur
Message
string
Message d'information sur l'erreur
documentation_url
string
Lien vers la documentation
documentation_url
string
Lien vers la documentation

429 : Too Many Requests

Type de données
Description
(objet)
Message
string
Infos sur l'erreur
documentation_url
string
Lien vers la documentation

Examples

C#

https://github.com/looker-open-source/sdk-codegen/blob/main/csharp/sdk/3.1/methods.cs
https://github.com/looker-open-source/sdk-codegen/blob/main/csharp/sdk/4.0/methods.cs

Go

https://github.com/looker-open-source/sdk-codegen/blob/main/go/sdk/v4/methods.go

Kotlin

https://github.com/looker-open-source/sdk-codegen/blob/main/kotlin/src/main/com/looker/sdk/4.0/methods.kt
https://github.com/looker-open-source/sdk-codegen/blob/main/kotlin/src/main/com/looker/sdk/4.0/streams.kt

TypeScript

https://github.com/looker-open-source/sdk-codegen/blob/main/packages/sdk/src/3.1/funcs.ts
https://github.com/looker-open-source/sdk-codegen/blob/main/packages/sdk/src/3.1/methods.ts
https://github.com/looker-open-source/sdk-codegen/blob/main/packages/sdk/src/3.1/methodsInterface.ts
https://github.com/looker-open-source/sdk-codegen/blob/main/packages/sdk/src/3.1/streams.ts
https://github.com/looker-open-source/sdk-codegen/blob/main/packages/sdk/src/4.0/funcs.ts
https://github.com/looker-open-source/sdk-codegen/blob/main/packages/sdk/src/4.0/methods.ts
https://github.com/looker-open-source/sdk-codegen/blob/main/packages/sdk/src/4.0/methodsInterface.ts
https://github.com/looker-open-source/sdk-codegen/blob/main/packages/sdk/src/4.0/streams.ts
https://github.com/looker-open-source/sdk-codegen/blob/main/packages/sdk-codegen/src/python.gen.spec.ts

Python

https://github.com/looker-open-source/sdk-codegen/blob/main/python/looker_sdk/sdk/api31/methods.py
https://github.com/looker-open-source/sdk-codegen/blob/main/python/looker_sdk/sdk/api40/methods.py

Swift

https://github.com/looker-open-source/sdk-codegen/blob/main/swift/looker/sdk/methods.swift
https://github.com/looker-open-source/sdk-codegen/blob/main/swift/looker/sdk/streams.swift