Esegui query codificata URL

Versione 3.1.23.6

Eseguire una query con codifica URL.

Ciò richiede al chiamante di codificare gli specificatori della query nella parte della query URL utilizzando la sintassi specifica di Looker, come spiegato di seguito.

In genere, è consigliabile utilizzare uno dei metodi che utilizzano i parametri come JSON nel corpo POST per creare e/o eseguire query. Questo metodo esiste nei casi in cui è necessario codificare i parametri nell'URL di una singola richiesta "GET". Questo corrisponde al modo in cui l'interfaccia utente di Looker formatta gli URL "esplora" e così via.

Questi parametri sono molto simili alla formattazione del corpo del file JSON, tranne per il fatto che la sintassi del filtro è complessa. Purtroppo, questo formato rende attualmente non richiamabile questo metodo tramite il pulsante "Prova" in questa pagina della documentazione. Tuttavia, ciò è richiamabile quando crei URL manualmente o quando utilizzi l'SDK Looker.

Di seguito è riportato un URL di query in linea di esempio:

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

Quando si chiama questo endpoint con l'SDK Ruby, trasmetti le parti del parametro di ricerca come hash. L'hash corrispondente a quanto sopra potrebbe avere il seguente aspetto:

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)

Anche in questo caso, è più facile utilizzare la variante di questo metodo che trasmette la query completa nel corpo POST. Questo metodo è disponibile per i casi in cui altre alternative non soddisfano le necessità.

Formati supportati:

formato_risultato Descrizione
json JSON semplice
json_dettaglio Dati sulle righe più metadati che descrivono i campi, i pivot, le tabelle dei calcoli e altri aspetti della query
csv Valori separati da virgola con un'intestazione
file txt Valori separati da tabulazione con un'intestazione
html HTML semplice
md Markdown semplice
xlsx Foglio di lavoro MS Excel
sql Restituisce l'SQL generato anziché eseguire la query
PNG Un'immagine PNG della visualizzazione della query
JPG Un'immagine JPG della visualizzazione della query

Richiesta

GET /queries/models/{model_name}/views/{view_name}/run/{result_format}
Tipo di dati
Descrizione
Richiesta
HTTPRequest
percorso
Percorso HTTP
Espandi definizione HTTPPath...
nome_modello
string
Nome modello
nome_visualizzazione
string
Nome visualizzazione
formato_risultato
string
Formato del risultato

Risposta

200: query

Tipo di dati
Descrizione
(stringa)
string

400: Richiesta errata

Tipo di dati
Descrizione
(oggetto)
messaggio
string
Error details (Dettagli errore)
documentazione_url
string
Link alla documentazione

404: Non trovata

Tipo di dati
Descrizione
(oggetto)
messaggio
string
Error details (Dettagli errore)
documentazione_url
string
Link alla documentazione

422: Errore di convalida

Tipo di dati
Descrizione
messaggio
string
Error details (Dettagli errore)
Espandi definizione ValidationErrorDetails...
campo
string
Campo con errore
codice
string
Codice di errore
messaggio
string
Messaggio informativo sull'errore
documentazione_url
string
Link alla documentazione
documentazione_url
string
Link alla documentazione

429: Troppe richieste

Tipo di dati
Descrizione
(oggetto)
messaggio
string
Error details (Dettagli errore)
documentazione_url
string
Link alla documentazione

Esempi

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