Executar consulta codificada do URL

Versão 4.0.23.4

Execute uma consulta codificada pelo URL.

Isso exige que o chamador codifique os especificadores da consulta na parte da consulta do URL usando a sintaxe específica do Looker, conforme explicado abaixo.

Geralmente, convém usar um dos métodos que usam os parâmetros como json no corpo POST para criar e/ou executar consultas. Esse método existe para os casos em que é realmente necessário codificar os parâmetros no URL de uma única solicitação "GET". Isso corresponde à maneira como a IU do Looker formata URLs "explorar" etc.

Os parâmetros aqui são muito semelhantes à formatação do corpo json, exceto pelo fato de a sintaxe do filtro ser complexa. Infelizmente, este formato torna este método não chamável atualmente por meio do botão "Faça um teste" nesta página de documentação. No entanto, isso pode ser chamado ao criar URLs manualmente ou ao usar o SDK do Looker.

Veja um exemplo de URL de consulta in-line:

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

Ao invocar esse endpoint com o SDK do Ruby, transmita as partes do parâmetro de consulta como um hash. O hash correspondente ao exemplo acima seria semelhante a este:

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)

Novamente, é mais fácil usar a variante desse método que passe a consulta completa no corpo POST. Esse método está disponível para os casos em que outras alternativas não atendem à necessidade.

Formatos compatíveis:

formato_do_resultado Descrição
json JSON simples
json_detail [informações_técnicas_do_json] Dados de linha mais metadados que descrevem os campos, tabelas dinâmicas, cálculos de tabela e outros aspectos da consulta
csv Valores separados por vírgula com um cabeçalho
.txt Valores separados por tabulação com um cabeçalho
html HTML simples
MD Markdown simples
xlsx Planilha do MS Excel
sql Retorna o SQL gerado em vez de executar a consulta
png Uma imagem PNG da visualização da consulta
jpg Uma imagem JPG da visualização da consulta

Solicitação

GET /queries/models/{model_name}/views/{view_name}/run/{result_format}
Tipo de dados
Descrição
Solicitação
HTTPRequest
path
HTTPPath
Expandir definição HTTPPath...
model_name
string
Nome do modelo
nome_da_visualização
string
Nome da visualização
formato_do_resultado
string
Formato do resultado

Resposta

200: consulta

Tipo de dados
Descrição
(string)
string

400: Solicitação inválida

Tipo de dados
Descrição
(objeto)
mensagem
string
Detalhes do erro
url_da_documentação
string
Link da documentação

404: não encontrado

Tipo de dados
Descrição
(objeto)
mensagem
string
Detalhes do erro
url_da_documentação
string
Link da documentação

422: erro de validação

Tipo de dados
Descrição
(objeto)
mensagem
string
Detalhes do erro
Expandir a definição de ValidationErrorDetail...
campo
string
Campo com erro
código
string
Código do erro
mensagem
string
Mensagem de erro
url_da_documentação
string
Link da documentação
url_da_documentação
string
Link da documentação

429: Solicitações demais

Tipo de dados
Descrição
(objeto)
mensagem
string
Detalhes do erro
url_da_documentação
string
Link da documentação

Examples

C#

https://github.com/looker-open-source/sdk-codegen/blob/main/csharp/sdk/3.1/methods.cs (em inglês)
https://github.com/looker-open-source/sdk-codegen/blob/main/csharp/sdk/4.0/methods.cs (em inglês)

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 (em inglês)
https://github.com/looker-open-source/sdk-codegen/blob/main/kotlin/src/main/com/looker/sdk/4.0/streams.kt (em inglês)

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 (em inglês)
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 (em inglês)
https://github.com/looker-open-source/sdk-codegen/blob/main/swift/looker/sdk/streams.swift (em inglês)