Acessar exploração de modelo do LookML

Versão 4.0.23.6 (mais recente)

Receba informações sobre uma exploração de modelo lookml.

Solicitação

GET /lookml_models/{lookml_model_name}/explores/{explore_name}
Tipo de dados
Descrição
Solicitação
HTTPRequest
path
HTTPPath
Expandir definição HTTPPath...
lookml_model_name
string
Nome do modelo lookml.
explorar_nome
string
Nome da exploração.
consulta
Consulta HTTP
Expandir a definição de HTTPQuery...
campos
string
Campos solicitados.

Resposta

200: exploração de modelos LookML

Tipo de dados
Descrição
(objeto)
LookmlModelExplore (em inglês)
id
string
Nome completo da exploração (nome do modelo e nome da exploração)
nome
string
Explorar nome
Descrição
string
Descrição
Rótulo
string
Identificador
title
string
Ver título
scopes
string[]
total_canto
booleano
Total de lata
pode_desenvolver
booleano
Pode desenvolver LookML
can_see_lookml
booleano
Pode ver o LookML
look_ml
string
Um URL que leva à definição desta exploração no IDE do LookML.
pode_salvar
booleano
Pode salvar
explicação
booleano
Pode explicar
can_pivot_in_db
booleano
Pode dinamizar no banco de dados
subtotal
booleano
Pode usar subtotais
has_timezone_support (em inglês)
booleano
Compatível com fuso horário
suporta_custo_estimativa
booleano
Estimativas de custo compatíveis
connection_name
string
Nome da conexão
tratamento_para_separação_de_nulo
string
Como os valores nulos são classificados, os valores possíveis são "baixo", "alto", "primeiro" e "último"
arquivos
string[]
arquivo_de_origem
string
Arquivo source_file principal
nome_do_projeto
string
Nome do projeto
model_name
string
Nome do modelo
nome_da_visualização
string
Nome da vista
escondida
booleano
Está oculto
nome_da_tabela_do_sql
string
Uma expressão sql_table_name que define para qual tabela do sql a visualização/exploração é mapeada. Exemplo: "prod_orders2 pedidos AS" em uma visualização chamada "pedidos".
access_filter_fields
string[]
Expandir a definição de LookmlModelExploreAccessFilter...
campo
string
Campo a ser filtrado
Atributo do usuário
string
Nome do atributo do usuário
Expandir a definição de LookmlModelExploreAlias...
nome
string
Nome
valor
string
Valor
Expandir definição de LookmlModelExploreAlwaysFilter...
nome
string
Nome
valor
string
Valor
Expandir a definição de LookmlModelExploreConditionlyFilter...
nome
string
Nome
valor
string
Valor
index_fields
string[]
conjuntos
Expandir a definição de LookmlModelExploreSet...
nome
string
Nome
valor
string[]
tags
string[]
Expandir a definição de LookmlModelExploreError...
mensagem
string
Mensagem de erro
detalhes
Detalhes
erro_pos
string
Local da origem do erro
erro de campo
booleano
Isso é um erro de campo?
campos
Campos
Expandir a definição de LookmlModelExploreFieldset...
Expandir a definição de LookmlModelExploreField...
alinhar
string
O alinhamento de texto horizontal adequado em que os valores deste campo devem ser exibidos. Os valores válidos são: "left", "right".
filtro_canto
booleano
Indica se é possível filtrar esse campo.
categoria
string
Os valores válidos da categoria do campo são: "parameter", "filter", "measure" e "dimension".
valor_padrão_do_filtro
string
O valor padrão que este campo usa ao filtrar. Nulo se não houver valor padrão.
Descrição
string
Descrição
grupo_dimensão
string
Grupo de dimensões se este campo fizer parte de um grupo de dimensões. Caso contrário, será nulo.
error
string
Uma mensagem de erro indicando um problema com a definição deste campo. Se não houver erros, esse valor será nulo.
rótulo_do_grupo_de_campos
string
Um rótulo que cria um agrupamento de campos. Todos os campos com esse rótulo devem ser apresentados juntos quando exibidos em uma UI.
campo_grupo_de_campos
string
Quando apresentado em um grupo de campos via field_group_label, um nome mais curto do campo a ser exibido nesse contexto.
preencher_estilo
string
O estilo de preenchimento de dimensão que é possível para esse campo. Nulo se não for possível preencher a dimensão. Os valores válidos são: "enumeração", "range".
deslocamento_mês_tributário
integer
Uma compensação (em meses) do mês de início do calendário ao mês de início fiscal definido no modelo LookML ao qual este campo pertence.
has_allowed_values
booleano
Se este campo tem um conjunto de allowed_values especificado no LookML.
escondida
booleano
Indica se este campo deve ser oculto da interface do usuário.
filtro_is
booleano
Se este campo é um filtro.
is_fiscal
booleano
Se este campo representa um valor de tempo fiscal.
is_numérico
booleano
Se este campo é de um tipo que representa um valor numérico.
is_timeframe
booleano
Se este campo é de um tipo que representa um valor de tempo.
filtro_canto_tempo
booleano
Se este campo pode ser filtrado.
intervalo_de_tempo
Detalhes sobre o intervalo de tempo que este campo representa, se for.
Rótulo
string
Rótulo legível por humanos do campo.
label_from_parameter
string
O nome do parâmetro que fornecerá um rótulo parametrizado para este campo, se disponível no contexto atual.
rótulo_curto
string
O rótulo legível do campo, sem o rótulo da visualização.
look_ml
string
Um URL vinculado à definição desse campo no IDE do LookML.
camada_do_mapa
Se aplicável, uma camada do mapa à qual este campo está associado.
medição
booleano
Se este campo é uma medida.
nome
string
Nome totalmente qualificado do campo.
Strict_value_format
booleano
Em caso afirmativo, o campo não será localizado com o atributo "user_format". O padrão é "não"
parâmetro
booleano
Se este campo é um parâmetro.
permanente
booleano
Se este campo pode ser removido de uma consulta.
chave_principal
booleano
Se o campo representa ou não uma chave primária.
nome_do_projeto
string
O nome do projeto em que esse campo é definido.
required_refresh_on_sort
booleano
Quando verdadeiro, não é possível reclassificar os valores desse campo sem executar novamente a consulta SQL, devido à lógica do banco de dados que afeta a classificação.
escopo
string
O escopo do LookML ao qual este campo pertence. O escopo costuma ser a visualização do campo.
classificável
booleano
Se este campo pode ser classificado.
arquivo_de_origem
string
A parte do caminho de source_file_path.
caminho_do_arquivo_de_origem
string
O caminho totalmente qualificado do arquivo de projeto em que esse campo está definido.
sql
string
Expressão SQL conforme definida no modelo LookML. A sintaxe SQL mostrada aqui é uma representação destinada à auditabilidade e não é necessariamente uma correspondência exata do que será executado no banco de dados. Ele pode conter sintaxe LookML especial ou anotações que não sejam SQL válidas. Será nulo se o usuário atual não tiver a permissão see_lookml para o modelo do campo.
sugerir_dimensão
string
O nome da dimensão que será usada para sugerir consultas.
sugerir_explorar
string
O nome da exploração que será usada para sugerir consultas.
sugestivo
booleano
Se as sugestões são possíveis ou não para este campo.
sugestões
string[]
tags
string[]
tipo
string
O tipo LookML do campo.
tipos_de_filtro_do_atributo_do_usuário
string[]
formato_do_valor
string
Se especificada, a string de formato do valor LookML para valores de formatação deste campo.
visualização
string
O nome da visualização a que este campo pertence.
ver_marcador
string
O rótulo legível da visualização a que o campo pertence.
dynamic
booleano
Se este campo foi especificado em "dynamic_fields" e não faz parte do modelo.
dia_início_semanal
string
O nome do dia inicial da semana. Os valores válidos são: "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday".
vezes_usados
integer
O número de vezes que este campo foi usado em consultas
vista_original
string
O nome da visualização em que esse campo é definido. Ele será diferente de "view" quando a visualização tiver sido unificada usando um nome diferente usando o parâmetro "from".
Expandir a definição de LookmlModelExploreField...
alinhar
string
O alinhamento de texto horizontal adequado em que os valores deste campo devem ser exibidos. Os valores válidos são: "left", "right".
filtro_canto
booleano
Indica se é possível filtrar esse campo.
categoria
string
Os valores válidos da categoria do campo são: "parameter", "filter", "measure" e "dimension".
valor_padrão_do_filtro
string
O valor padrão que este campo usa ao filtrar. Nulo se não houver valor padrão.
Descrição
string
Descrição
grupo_dimensão
string
Grupo de dimensões se este campo fizer parte de um grupo de dimensões. Caso contrário, será nulo.
error
string
Uma mensagem de erro indicando um problema com a definição deste campo. Se não houver erros, esse valor será nulo.
rótulo_do_grupo_de_campos
string
Um rótulo que cria um agrupamento de campos. Todos os campos com esse rótulo devem ser apresentados juntos quando exibidos em uma UI.
campo_grupo_de_campos
string
Quando apresentado em um grupo de campos via field_group_label, um nome mais curto do campo a ser exibido nesse contexto.
preencher_estilo
string
O estilo de preenchimento de dimensão que é possível para esse campo. Nulo se não for possível preencher a dimensão. Os valores válidos são: "enumeração", "range".
deslocamento_mês_tributário
integer
Uma compensação (em meses) do mês de início do calendário ao mês de início fiscal definido no modelo LookML ao qual este campo pertence.
has_allowed_values
booleano
Se este campo tem um conjunto de allowed_values especificado no LookML.
escondida
booleano
Indica se este campo deve ser oculto da interface do usuário.
filtro_is
booleano
Se este campo é um filtro.
is_fiscal
booleano
Se este campo representa um valor de tempo fiscal.
is_numérico
booleano
Se este campo é de um tipo que representa um valor numérico.
is_timeframe
booleano
Se este campo é de um tipo que representa um valor de tempo.
filtro_canto_tempo
booleano
Se este campo pode ser filtrado.
intervalo_de_tempo
Detalhes sobre o intervalo de tempo que este campo representa, se for.
Rótulo
string
Rótulo legível por humanos do campo.
label_from_parameter
string
O nome do parâmetro que fornecerá um rótulo parametrizado para este campo, se disponível no contexto atual.
rótulo_curto
string
O rótulo legível do campo, sem o rótulo da visualização.
look_ml
string
Um URL vinculado à definição desse campo no IDE do LookML.
camada_do_mapa
Se aplicável, uma camada do mapa à qual este campo está associado.
medição
booleano
Se este campo é uma medida.
nome
string
Nome totalmente qualificado do campo.
Strict_value_format
booleano
Em caso afirmativo, o campo não será localizado com o atributo "user_format". O padrão é "não"
parâmetro
booleano
Se este campo é um parâmetro.
permanente
booleano
Se este campo pode ser removido de uma consulta.
chave_principal
booleano
Se o campo representa ou não uma chave primária.
nome_do_projeto
string
O nome do projeto em que esse campo é definido.
required_refresh_on_sort
booleano
Quando verdadeiro, não é possível reclassificar os valores desse campo sem executar novamente a consulta SQL, devido à lógica do banco de dados que afeta a classificação.
escopo
string
O escopo do LookML ao qual este campo pertence. O escopo costuma ser a visualização do campo.
classificável
booleano
Se este campo pode ser classificado.
arquivo_de_origem
string
A parte do caminho de source_file_path.
caminho_do_arquivo_de_origem
string
O caminho totalmente qualificado do arquivo de projeto em que esse campo está definido.
sql
string
Expressão SQL conforme definida no modelo LookML. A sintaxe SQL mostrada aqui é uma representação destinada à auditabilidade e não é necessariamente uma correspondência exata do que será executado no banco de dados. Ele pode conter sintaxe LookML especial ou anotações que não sejam SQL válidas. Será nulo se o usuário atual não tiver a permissão see_lookml para o modelo do campo.
sugerir_dimensão
string
O nome da dimensão que será usada para sugerir consultas.
sugerir_explorar
string
O nome da exploração que será usada para sugerir consultas.
sugestivo
booleano
Se as sugestões são possíveis ou não para este campo.
sugestões
string[]
tags
string[]
tipo
string
O tipo LookML do campo.
tipos_de_filtro_do_atributo_do_usuário
string[]
formato_do_valor
string
Se especificada, a string de formato do valor LookML para valores de formatação deste campo.
visualização
string
O nome da visualização a que este campo pertence.
ver_marcador
string
O rótulo legível da visualização a que o campo pertence.
dynamic
booleano
Se este campo foi especificado em "dynamic_fields" e não faz parte do modelo.
dia_início_semanal
string
O nome do dia inicial da semana. Os valores válidos são: "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday".
vezes_usados
integer
O número de vezes que este campo foi usado em consultas
vista_original
string
O nome da visualização em que esse campo é definido. Ele será diferente de "view" quando a visualização tiver sido unificada usando um nome diferente usando o parâmetro "from".
Expandir a definição de LookmlModelExploreField...
alinhar
string
O alinhamento de texto horizontal adequado em que os valores deste campo devem ser exibidos. Os valores válidos são: "left", "right".
filtro_canto
booleano
Indica se é possível filtrar esse campo.
categoria
string
Os valores válidos da categoria do campo são: "parameter", "filter", "measure" e "dimension".
valor_padrão_do_filtro
string
O valor padrão que este campo usa ao filtrar. Nulo se não houver valor padrão.
Descrição
string
Descrição
grupo_dimensão
string
Grupo de dimensões se este campo fizer parte de um grupo de dimensões. Caso contrário, será nulo.
error
string
Uma mensagem de erro indicando um problema com a definição deste campo. Se não houver erros, esse valor será nulo.
rótulo_do_grupo_de_campos
string
Um rótulo que cria um agrupamento de campos. Todos os campos com esse rótulo devem ser apresentados juntos quando exibidos em uma UI.
campo_grupo_de_campos
string
Quando apresentado em um grupo de campos via field_group_label, um nome mais curto do campo a ser exibido nesse contexto.
preencher_estilo
string
O estilo de preenchimento de dimensão que é possível para esse campo. Nulo se não for possível preencher a dimensão. Os valores válidos são: "enumeração", "range".
deslocamento_mês_tributário
integer
Uma compensação (em meses) do mês de início do calendário ao mês de início fiscal definido no modelo LookML ao qual este campo pertence.
has_allowed_values
booleano
Se este campo tem um conjunto de allowed_values especificado no LookML.
escondida
booleano
Indica se este campo deve ser oculto da interface do usuário.
filtro_is
booleano
Se este campo é um filtro.
is_fiscal
booleano
Se este campo representa um valor de tempo fiscal.
is_numérico
booleano
Se este campo é de um tipo que representa um valor numérico.
is_timeframe
booleano
Se este campo é de um tipo que representa um valor de tempo.
filtro_canto_tempo
booleano
Se este campo pode ser filtrado.
intervalo_de_tempo
Detalhes sobre o intervalo de tempo que este campo representa, se for.
Rótulo
string
Rótulo legível por humanos do campo.
label_from_parameter
string
O nome do parâmetro que fornecerá um rótulo parametrizado para este campo, se disponível no contexto atual.
rótulo_curto
string
O rótulo legível do campo, sem o rótulo da visualização.
look_ml
string
Um URL vinculado à definição desse campo no IDE do LookML.
camada_do_mapa
Se aplicável, uma camada do mapa à qual este campo está associado.
medição
booleano
Se este campo é uma medida.
nome
string
Nome totalmente qualificado do campo.
Strict_value_format
booleano
Em caso afirmativo, o campo não será localizado com o atributo "user_format". O padrão é "não"
parâmetro
booleano
Se este campo é um parâmetro.
permanente
booleano
Se este campo pode ser removido de uma consulta.
chave_principal
booleano
Se o campo representa ou não uma chave primária.
nome_do_projeto
string
O nome do projeto em que esse campo é definido.
required_refresh_on_sort
booleano
Quando verdadeiro, não é possível reclassificar os valores desse campo sem executar novamente a consulta SQL, devido à lógica do banco de dados que afeta a classificação.
escopo
string
O escopo do LookML ao qual este campo pertence. O escopo costuma ser a visualização do campo.
classificável
booleano
Se este campo pode ser classificado.
arquivo_de_origem
string
A parte do caminho de source_file_path.
caminho_do_arquivo_de_origem
string
O caminho totalmente qualificado do arquivo de projeto em que esse campo está definido.
sql
string
Expressão SQL conforme definida no modelo LookML. A sintaxe SQL mostrada aqui é uma representação destinada à auditabilidade e não é necessariamente uma correspondência exata do que será executado no banco de dados. Ele pode conter sintaxe LookML especial ou anotações que não sejam SQL válidas. Será nulo se o usuário atual não tiver a permissão see_lookml para o modelo do campo.
sugerir_dimensão
string
O nome da dimensão que será usada para sugerir consultas.
sugerir_explorar
string
O nome da exploração que será usada para sugerir consultas.
sugestivo
booleano
Se as sugestões são possíveis ou não para este campo.
sugestões
string[]
tags
string[]
tipo
string
O tipo LookML do campo.
tipos_de_filtro_do_atributo_do_usuário
string[]
formato_do_valor
string
Se especificada, a string de formato do valor LookML para valores de formatação deste campo.
visualização
string
O nome da visualização a que este campo pertence.
ver_marcador
string
O rótulo legível da visualização a que o campo pertence.
dynamic
booleano
Se este campo foi especificado em "dynamic_fields" e não faz parte do modelo.
dia_início_semanal
string
O nome do dia inicial da semana. Os valores válidos são: "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday".
vezes_usados
integer
O número de vezes que este campo foi usado em consultas
vista_original
string
O nome da visualização em que esse campo é definido. Ele será diferente de "view" quando a visualização tiver sido unificada usando um nome diferente usando o parâmetro "from".
parâmetros
Expandir a definição de LookmlModelExploreField...
alinhar
string
O alinhamento de texto horizontal adequado em que os valores deste campo devem ser exibidos. Os valores válidos são: "left", "right".
filtro_canto
booleano
Indica se é possível filtrar esse campo.
categoria
string
Os valores válidos da categoria do campo são: "parameter", "filter", "measure" e "dimension".
valor_padrão_do_filtro
string
O valor padrão que este campo usa ao filtrar. Nulo se não houver valor padrão.
Descrição
string
Descrição
grupo_dimensão
string
Grupo de dimensões se este campo fizer parte de um grupo de dimensões. Caso contrário, será nulo.
error
string
Uma mensagem de erro indicando um problema com a definição deste campo. Se não houver erros, esse valor será nulo.
rótulo_do_grupo_de_campos
string
Um rótulo que cria um agrupamento de campos. Todos os campos com esse rótulo devem ser apresentados juntos quando exibidos em uma UI.
campo_grupo_de_campos
string
Quando apresentado em um grupo de campos via field_group_label, um nome mais curto do campo a ser exibido nesse contexto.
preencher_estilo
string
O estilo de preenchimento de dimensão que é possível para esse campo. Nulo se não for possível preencher a dimensão. Os valores válidos são: "enumeração", "range".
deslocamento_mês_tributário
integer
Uma compensação (em meses) do mês de início do calendário ao mês de início fiscal definido no modelo LookML ao qual este campo pertence.
has_allowed_values
booleano
Se este campo tem um conjunto de allowed_values especificado no LookML.
escondida
booleano
Indica se este campo deve ser oculto da interface do usuário.
filtro_is
booleano
Se este campo é um filtro.
is_fiscal
booleano
Se este campo representa um valor de tempo fiscal.
is_numérico
booleano
Se este campo é de um tipo que representa um valor numérico.
is_timeframe
booleano
Se este campo é de um tipo que representa um valor de tempo.
filtro_canto_tempo
booleano
Se este campo pode ser filtrado.
intervalo_de_tempo
Detalhes sobre o intervalo de tempo que este campo representa, se for.
Rótulo
string
Rótulo legível por humanos do campo.
label_from_parameter
string
O nome do parâmetro que fornecerá um rótulo parametrizado para este campo, se disponível no contexto atual.
rótulo_curto
string
O rótulo legível do campo, sem o rótulo da visualização.
look_ml
string
Um URL vinculado à definição desse campo no IDE do LookML.
camada_do_mapa
Se aplicável, uma camada do mapa à qual este campo está associado.
medição
booleano
Se este campo é uma medida.
nome
string
Nome totalmente qualificado do campo.
Strict_value_format
booleano
Em caso afirmativo, o campo não será localizado com o atributo "user_format". O padrão é "não"
parâmetro
booleano
Se este campo é um parâmetro.
permanente
booleano
Se este campo pode ser removido de uma consulta.
chave_principal
booleano
Se o campo representa ou não uma chave primária.
nome_do_projeto
string
O nome do projeto em que esse campo é definido.
required_refresh_on_sort
booleano
Quando verdadeiro, não é possível reclassificar os valores desse campo sem executar novamente a consulta SQL, devido à lógica do banco de dados que afeta a classificação.
escopo
string
O escopo do LookML ao qual este campo pertence. O escopo costuma ser a visualização do campo.
classificável
booleano
Se este campo pode ser classificado.
arquivo_de_origem
string
A parte do caminho de source_file_path.
caminho_do_arquivo_de_origem
string
O caminho totalmente qualificado do arquivo de projeto em que esse campo está definido.
sql
string
Expressão SQL conforme definida no modelo LookML. A sintaxe SQL mostrada aqui é uma representação destinada à auditabilidade e não é necessariamente uma correspondência exata do que será executado no banco de dados. Ele pode conter sintaxe LookML especial ou anotações que não sejam SQL válidas. Será nulo se o usuário atual não tiver a permissão see_lookml para o modelo do campo.
sugerir_dimensão
string
O nome da dimensão que será usada para sugerir consultas.
sugerir_explorar
string
O nome da exploração que será usada para sugerir consultas.
sugestivo
booleano
Se as sugestões são possíveis ou não para este campo.
sugestões
string[]
tags
string[]
tipo
string
O tipo LookML do campo.
tipos_de_filtro_do_atributo_do_usuário
string[]
formato_do_valor
string
Se especificada, a string de formato do valor LookML para valores de formatação deste campo.
visualização
string
O nome da visualização a que este campo pertence.
ver_marcador
string
O rótulo legível da visualização a que o campo pertence.
dynamic
booleano
Se este campo foi especificado em "dynamic_fields" e não faz parte do modelo.
dia_início_semanal
string
O nome do dia inicial da semana. Os valores válidos são: "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday".
vezes_usados
integer
O número de vezes que este campo foi usado em consultas
vista_original
string
O nome da visualização em que esse campo é definido. Ele será diferente de "view" quando a visualização tiver sido unificada usando um nome diferente usando o parâmetro "from".
Expandir a definição de LookmlModelExploreJoins...
nome
string
Nome dessa mesclagem (e nome da visualização a ser mesclada)
campos dependentes
string[]
campos
string[]
chave estrangeira
string
Nome da dimensão nesta exploração cujo valor está na chave primária da visualização mesclada
de
string
Nome da vista para participar
outer_only
booleano
Especifica se todas as consultas precisam usar uma mesclagem externa
relationship
string
muitos_para_um, um_para_um, um_para_muitos, muitos_para_muitos
joins_obrigatórios
string[]
sql_foreign_key
string
Expressão SQL que produz uma chave externa
sql_on
string
Expressão SQL ON que descreve a condição de mesclagem
nome_da_tabela_do_sql
string
Nome da tabela SQL para mesclar
tipo
string
O tipo de mesclagem: "left_outer", "full_outer", "inner" ou "cross".
ver_marcador
string
Rótulo a ser exibido nos seletores de IU
rótulo_do_grupo
string
Rótulo usado para agrupar explorações nos menus de navegação
tipos_de_medida_compatíveis
Expandir a definição de LookmlModelExploreSupportedMeasureType...
tipo_de_dimensão
string
tipos_de_medida
string[]
sempre_participar
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

Examples