Ejecutar consulta codificada en URL

Versión 4.0.23.6 (más reciente)

Ejecutar una consulta codificada en URL

Esto requiere que el llamador codifique los especificadores de la consulta en la parte de la consulta de URL mediante la sintaxis específica de Looker como se explica a continuación.

En general, se recomienda usar uno de los métodos que toma los parámetros como JSON en el cuerpo de POST para crear o ejecutar consultas. Este método existe para los casos en los que uno necesita codificar los parámetros en la URL de una sola solicitud "GET". Esto coincide con la forma en que la IU de Looker da formato a las URLs de "exploración", etcétera.

Estos parámetros son muy similares al formato de cuerpo JSON, excepto que la sintaxis del filtro es complicada. Lamentablemente, este formato hace que no se pueda llamar a este método mediante el botón "Pruébalo" de esta página de documentación. Sin embargo, esto se puede llamar cuando se crean URLs de forma manual o cuando se usa el SDK de Looker.

Este es un ejemplo de URL de consulta intercalada:

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

Cuando invoque este extremo con el SDK de Ruby, pase las partes de los parámetros de consulta como un hash. El hash para que coincida con el aspecto anterior se vería de la siguiente manera:

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)

Una vez más, suele ser más fácil usar la variante de este método que pasa la consulta completa en el cuerpo de POST. Este método está disponible para los casos en que otras alternativas no satisfarán la necesidad.

Los formatos admitidos son los siguientes:

formato_resultado Descripción
json JSON simple
Detalles de JSON Datos de filas y metadatos que describen los campos, pivotes, cálculos de la tabla y otros aspectos de la consulta
csv Valores separados por comas con un encabezado
txt Valores separados por tabulaciones con un encabezado
html HTML simple
MD Markdown simple
xlsx Hoja de cálculo de MS Excel
sql Muestra el SQL generado en lugar de ejecutar la consulta
png Una imagen PNG de la visualización de la consulta
jpg Una imagen en formato JPG de la visualización de la consulta

Solicitud

GET /queries/models/{model_name}/views/{view_name}/run/{result_format}
Tipo de datos
Descripción
Solicitud
HTTPRequest
ruta
Ruta de HTTP
Expandir la definición HTTPPath...
model_name
string
Nombre del modelo
nombre_vista
string
Nombre de la vista
formato_resultado
string
Formato del resultado

Respuesta

200: consulta

Tipo de datos
Descripción
(string)
string

400: Bad Request

Tipo de datos
Descripción
(objeto)
mensaje,
string
Detalles del error
url_documentación
string
Vínculo a la documentación

404: No encontrado

Tipo de datos
Descripción
(objeto)
mensaje,
string
Detalles del error
url_documentación
string
Vínculo a la documentación

422: Error de validación

Tipo de datos
Descripción
(objeto)
mensaje,
string
Detalles del error
Expandir la definición de ValidationErrorDetail...
campo
string
Campo con error
código
string
Código de error
mensaje,
string
Mensaje de información de error
url_documentación
string
Vínculo a la documentación
url_documentación
string
Vínculo a la documentación

429: Demasiadas solicitudes

Tipo de datos
Descripción
(objeto)
mensaje,
string
Detalles del error
url_documentación
string
Vínculo a la documentación

Ejemplos

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