Versão 4.0.23.2
Observação: estes documentos são referentes a uma versão mais antiga da API. A referência da API também está disponível para
a versão mais recente, 4.0.23.6
.
Pesquisar elementos do painel
Retorna uma matriz de objetos DashboardElement que correspondem aos critérios de pesquisa especificados.
Se vários parâmetros de pesquisa forem fornecidos e filter_or
for FALSE ou não for especificado, eles serão combinados em uma operação lógica AND.
Somente as linhas que correspondem a todos os critérios de parâmetro de pesquisa serão retornadas.
Se filter_or
for TRUE, vários parâmetros de pesquisa serão combinados em uma operação lógica OR.
Os resultados incluirão linhas que correspondem a qualquer um dos critérios de pesquisa.
Os parâmetros de pesquisa da string usam correspondência indiferente a maiúsculas.
Os parâmetros de pesquisa de string podem conter %
e '_' como SQL COMO o padrão de correspondência de expressões de caractere curinga. example="dan%" corresponderá a "danger" e "Danzig", mas não a "David" example="D_m%" corresponderá a "Dageage" e "dump"
Parâmetros de pesquisa de número inteiro podem aceitar um único valor ou uma lista de valores separados por vírgulas. Os vários valores serão combinados em uma operação lógica de OR. Os resultados corresponderão a pelo menos um dos valores fornecidos.
A maioria dos parâmetros de pesquisa pode aceitar "IS NULL" e "NOT NULL" como expressões especiais para corresponder ou excluir (respectivamente) linhas em que a coluna é nula.
Os parâmetros de pesquisa booleana só aceitam valores "verdadeiro" e "falso".
Solicitação
GET
/dashboard_elements/search
Expandir a definição de HTTPQuery...
ID do painel
string
Selecionar elementos que se referem a um determinado ID do painel
look_id
string
Selecione elementos que façam referência a um determinado ID de aparência
title
string
Corresponder ao título do elemento
excluído
booleano
Selecionar elementos do painel excluídos de forma reversível
campos
string
Campos solicitados.
filtro_ou
booleano
Combinar determinados critérios de pesquisa em uma expressão booleana OR
classificações
string
Campos para classificação. Campos classificáveis: [:look_id, :dashboard_id, :deleted, :title]
Resposta
200: elementos do painel
pode
lock
objeto
Operações que o usuário atual pode realizar neste objeto
corpo_texto
string
Texto do corpo do bloco de texto
corpo_texto_como_html
lock
string
Texto do bloco de texto como HTML
ID do painel
string
ID do painel
editar_uri
lock
string
Caminho relativo do URI do arquivo LookML para editar o elemento do painel (somente painel LookML).
id
lock
string
ID exclusivo
tenham a mesma aparência
lock
Look
Expandir a definição de LookWithQuery...
pode
lock
objeto
Operações que o usuário atual pode realizar neste objeto
Content_metadata_id
lock
string
ID dos metadados de conteúdo
id
lock
string
ID exclusivo
title
string
Título do visual
user_id
string
ID do usuário
content_favorite_id [código_de_conteúdo]
lock
string
ID do conteúdo favorito
criado_em
lock
string
Hora em que a aparência foi criada.
excluído
booleano
Indica se um visual foi excluído de maneira reversível.
excluído_em
lock
string
Hora em que a aparência foi excluída.
código_de_exclusão
lock
string
ID do usuário que excluiu a aparência.
Descrição
string
Descrição
URL_incorporado
lock
string
Incorporar URL
excel_file_url
lock
string
URL do arquivo do Excel
contagem_favorita
lock
integer
Número de vezes favorito
Planilha_de_planilhas
lock
string
Fórmula da planilha do Google
imagem_incorporada_url
lock
string
URL de incorporação de imagem
is_run_on_load
booleano
executar consulta automaticamente quando a visualização tiver sido visualizada
last_accessed_at
lock
string
Hora em que o acesso foi acessado pela última vez por qualquer usuário
ID_do_último_atualizado
lock
string
ID do usuário que atualizou a aparência pela última vez.
last_viewed_at
lock
string
Hora da última visualização na IU da Web do Looker
Expandir a definição do LookModel...
id
lock
string
ID do modelo
Rótulo
lock
string
Rótulo do modelo
público
booleano
É público
lesma_pública
lock
string
Lesma pública
URL_público
lock
string
URL público
ID da consulta
string
ID da consulta
URL_curto
lock
string
URL curto
pasta
lock
Pasta desta aparência
Expandir a definição de FolderBase...
nome
string
Nome exclusivo
parent_id
string
ID do pai. Se o ID pai for nulo, é uma entrada de nível raiz
id
lock
string
ID exclusivo
Content_metadata_id
lock
string
ID dos metadados de conteúdo
criado_em
lock
string
Hora em que a pasta foi criada
ID do criador
lock
string
User ID do criador
contagem_filho
lock
integer
Contagem de crianças
ID_externo
lock
string
Código do incorporador se esta pasta foi gerada automaticamente como uma pasta compartilhada de incorporação via 'external_group_id' em um login de incorporação de SSO
is_embed
lock
booleano
Pasta é uma pasta incorporada
raiz_integrada_compartilhada
lock
booleano
Pasta é a pasta compartilhada incorporada como raiz
is_embed_users_root
lock
booleano
Pasta é a pasta raiz incorporada de usuários
é_pessoal
lock
booleano
Pasta é a pasta pessoal do usuário
is_personal_descendente
lock
booleano
A pasta é descendente da pasta pessoal de um usuário
raiz_compartilhada
lock
booleano
Pasta é a pasta compartilhada raiz
root_users_root
lock
booleano
Pasta é a pasta raiz do usuário
pode
lock
objeto
Operações que o usuário atual pode realizar neste objeto
ID da pasta
string
ID da pasta
atualizado em
lock
string
Hora em que a aparência foi atualizada.
contagem_de_visualizações
lock
integer
Número de visualizações na IU da Web do Looker
Expandir definição da consulta...
pode
lock
objeto
Operações que o usuário atual pode realizar neste objeto
id
lock
string
ID exclusivo
visualização
string
Explorar nome
expressao_de_filtro
string
Expressão de filtro
limit_column
string
Limite de colunas
total da linha
string
Total bruto
vis_config
objeto
Propriedades de configuração da visualização. Essas propriedades geralmente são opacas e diferem com base no tipo de visualização usada. Não há um conjunto especificado de chaves permitidas. Os valores podem ser qualquer tipo compatível com JSON. Uma chave de "tipo" com um valor de string geralmente está presente e é usada pelo Looker para determinar qual visualização será exibida. As visualizações ignoram as propriedades vis_config desconhecidas.
configuração_do_filtro
objeto
O valor de "filter_config" representa o estado da IU do filtro na página de exploração de uma determinada consulta. Ao executar uma consulta por meio da IU do Looker, esse parâmetro tem precedência sobre "filtros". Ao criar uma consulta ou modificar uma consulta existente, "filter_config" deve ser definido como nulo. Definir como qualquer outro valor pode causar um comportamento inesperado de filtragem. O formato deve ser considerado opaco.
_UI_sections visíveis
string
Seções de IU visíveis
dynamic_fields
string
Campos dinâmicos
client_id
string
ID do cliente: usado para gerar URLs de exploração encurtados. Se definido pelo cliente, deve ser uma sequência alfanumérica única de 22 caracteres. Caso contrário, será gerado um.
url_de_compartilhamento
lock
string
Compartilhar URL
url_de_compartilhamento_expandido
lock
string
URL de compartilhamento expandido
url
lock
string
URL expandido
fuso horário_de_consulta
string
Fuso horário da consulta
has_table_calculations
lock
booleano
Tem cálculos de tabela
look_id
string
ID da aparência
lookml_link_id
lock
string
ID do link LookML
código_do_resultado_da_mesclagem
string
ID do resultado da mesclagem
display_display
string
Exibição da nota
estado_da_nota
string
Estado da nota
texto_da_nota
string
Texto da nota
nota_texto_como_html
lock
string
Nota em formato HTML
Expandir definição da consulta...
pode
lock
objeto
Operações que o usuário atual pode realizar neste objeto
id
lock
string
ID exclusivo
visualização
string
Explorar nome
expressao_de_filtro
string
Expressão de filtro
limit_column
string
Limite de colunas
total da linha
string
Total bruto
vis_config
objeto
Propriedades de configuração da visualização. Essas propriedades geralmente são opacas e diferem com base no tipo de visualização usada. Não há um conjunto especificado de chaves permitidas. Os valores podem ser qualquer tipo compatível com JSON. Uma chave de "tipo" com um valor de string geralmente está presente e é usada pelo Looker para determinar qual visualização será exibida. As visualizações ignoram as propriedades vis_config desconhecidas.
configuração_do_filtro
objeto
O valor de "filter_config" representa o estado da IU do filtro na página de exploração de uma determinada consulta. Ao executar uma consulta por meio da IU do Looker, esse parâmetro tem precedência sobre "filtros". Ao criar uma consulta ou modificar uma consulta existente, "filter_config" deve ser definido como nulo. Definir como qualquer outro valor pode causar um comportamento inesperado de filtragem. O formato deve ser considerado opaco.
_UI_sections visíveis
string
Seções de IU visíveis
dynamic_fields
string
Campos dinâmicos
client_id
string
ID do cliente: usado para gerar URLs de exploração encurtados. Se definido pelo cliente, deve ser uma sequência alfanumérica única de 22 caracteres. Caso contrário, será gerado um.
url_de_compartilhamento
lock
string
Compartilhar URL
url_de_compartilhamento_expandido
lock
string
URL de compartilhamento expandido
url
lock
string
URL expandido
fuso horário_de_consulta
string
Fuso horário da consulta
has_table_calculations
lock
booleano
Tem cálculos de tabela
ID da consulta
string
ID da consulta
intervalo_de_atualização
string
Intervalo de atualização
intervalo_de_atualização_para_i
lock
integer
Atualizar intervalo como número inteiro
criador_de_resultados
Dados sobre o criador de resultados.
Expandir a definição de ResultMakerWithIdVisConfigAndDynamicFields...
id
lock
string
ID exclusivo.
dynamic_fields
lock
string
String JSON de informações de campo dinâmico.
Expandir a definição de ResultMakerFilterables...
modelo
lock
string
O modelo de origem deste filtro (usado para sugestões de campo).
visualização
lock
string
A vista da propriedade dessa fonte filtrável (usada para sugestões de campo).
nome
lock
string
O nome do elemento filtrável (consulta ou resultados mesclados).
código_do_resultado_da_mesclagem
lock
string
ID do resultado da mesclagem se este for um merge_result.
total
lock
booleano
Total da consulta constituinte, consulta ou mesclagem de consulta
ID da consulta
lock
string
ID da consulta, se for uma consulta.
id_consulta_sql
lock
string
ID da consulta SQL, se for uma consulta do SQL Runner
Expandir definição da consulta...
pode
lock
objeto
Operações que o usuário atual pode realizar neste objeto
id
lock
string
ID exclusivo
visualização
string
Explorar nome
expressao_de_filtro
string
Expressão de filtro
limit_column
string
Limite de colunas
total da linha
string
Total bruto
vis_config
objeto
Propriedades de configuração da visualização. Essas propriedades geralmente são opacas e diferem com base no tipo de visualização usada. Não há um conjunto especificado de chaves permitidas. Os valores podem ser qualquer tipo compatível com JSON. Uma chave de "tipo" com um valor de string geralmente está presente e é usada pelo Looker para determinar qual visualização será exibida. As visualizações ignoram as propriedades vis_config desconhecidas.
configuração_do_filtro
objeto
O valor de "filter_config" representa o estado da IU do filtro na página de exploração de uma determinada consulta. Ao executar uma consulta por meio da IU do Looker, esse parâmetro tem precedência sobre "filtros". Ao criar uma consulta ou modificar uma consulta existente, "filter_config" deve ser definido como nulo. Definir como qualquer outro valor pode causar um comportamento inesperado de filtragem. O formato deve ser considerado opaco.
_UI_sections visíveis
string
Seções de IU visíveis
dynamic_fields
string
Campos dinâmicos
client_id
string
ID do cliente: usado para gerar URLs de exploração encurtados. Se definido pelo cliente, deve ser uma sequência alfanumérica única de 22 caracteres. Caso contrário, será gerado um.
url_de_compartilhamento
lock
string
Compartilhar URL
url_de_compartilhamento_expandido
lock
string
URL de compartilhamento expandido
url
lock
string
URL expandido
fuso horário_de_consulta
string
Fuso horário da consulta
has_table_calculations
lock
booleano
Tem cálculos de tabela
vis_config
lock
objeto
Configuração de visualização da consulta constituinte ou Mesclar consulta.
código_do_produto_de_resultado
string
ID da entrada ResultMakerLookup.
texto do subtítulo
string
Texto do subtítulo do bloco do texto
title
string
Título do elemento do painel
título_oculto
booleano
Se o título está oculto
texto_título
string
Título do bloco de texto
contagem_de_alertas
lock
integer
Contagem de alertas associados a um elemento do painel
rich_content_json
string
JSON com todas as propriedades necessárias para elementos ricos de editor e botões
título_texto_como_html
lock
string
Texto do título do bloco de texto como HTML
subtitle_text_as_html
lock
string
Texto do subtítulo do bloco de texto como HTML
ID da extensão
string
ID da extensão
400: Solicitação inválida
mensagem
lock
string
Detalhes do erro
url_da_documentação
lock
string
Link da documentação
404: não encontrado
mensagem
lock
string
Detalhes do erro
url_da_documentação
lock
string
Link da documentação