Versão 4.0.23.2
Executar uma aparência
Executa a consulta de um determinado visual e retorna os resultados no formato solicitado.
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
/looks/{look_id}/run/{result_format}
Tipo de dados
Descrição
Solicitação
path
Expandir definição HTTPPath...
look_id
ID da aparência
formato_do_resultado
Formato do resultado
consulta
Expandir a definição de HTTPQuery...
limite
Limite de linhas (pode substituir o limite na consulta salva).
aplicar_formatação
Aplique a formatação especificada pelo modelo a cada resultado.
apply_vis
Aplique as opções de visualização aos resultados.
Armazenamento em cache
Receber resultados do cache, se disponível.
imagem_largura
Largura da renderização para formatos de imagem.
imagem_altura
Altura da renderização para formatos de imagem.
generate_drill_links
Gerar links de detalhamento (aplicável somente ao formato "json_detail").
forçar_produção
Força o uso de modelos de produção, mesmo que o usuário esteja no modo de desenvolvimento. Essa sinalização falsa não garante que modelos de desenvolvimento serão usados.
somente cache
Recupere resultados do cache mesmo que eles tenham expirado.
prefixo_do_caminho
Prefixo a ser usado para links de detalhamento (codificado pelo URL).
recriar_pdts
Recriar PDTS usados na consulta.
server_table_calcs
Realizar cálculos de tabela nos resultados da consulta
Resposta
200: aparência
Tipo de dados
Descrição
(string)
400: Solicitação inválida
Tipo de dados
Descrição
(objeto)
mensagem
lock
Detalhes do erro
url_da_documentação
lock
Link da documentação
404: não encontrado
Tipo de dados
Descrição
(objeto)
mensagem
lock
Detalhes do erro
url_da_documentação
lock
Link da documentação
422: erro de validação
Tipo de dados
Descrição
(objeto)
mensagem
lock
Detalhes do erro
erros
Expandir a definição de ValidationErrorDetail...
campo
lock
Campo com erro
código
lock
Código do erro
mensagem
lock
Mensagem de erro
url_da_documentação
lock
Link da documentação
url_da_documentação
lock
Link da documentação
429: Solicitações demais
Tipo de dados
Descrição
(objeto)
mensagem
lock
Detalhes do erro
url_da_documentação
lock
Link da documentação
Examples
Python
Ruby
TypeScript