Versão 4.0.23.6 (mais recente)
A API Looker fornece acesso à grande maioria das funcionalidades do Looker por meio de uma conveniente API REST orientada a JSON. Para uma introdução sobre a API, consulte a Visão geral da API e o Guia de primeiros passos.
Esta referência de API fornece detalhes sobre métodos/endpoints expostos por meio da API, bem como definições de tipo que definem as estruturas de solicitação e resposta.
Métodos
Alerta
ApiAuth
Artefato
Auth
- Criar secret incorporado
- Excluir secret incorporado
- Criar URL de incorporação de SSO
- Criar URL incorporado
- Criar sessão de incorporação sem cookies
- Excluir sessão de incorporação sem cookies
- Gerar tokens para uma sessão de incorporação sem cookies
- Acessar a configuração LDAP
- Atualizar configuração LDAP
- Testar conexão LDAP
- Testar a autenticação LDAP
- Testar informações do usuário LDAP
- Testar a autenticação de usuário LDAP
- Registrar dispositivo móvel
- Atualizar o registro do dispositivo móvel
- Cancelar o registro do dispositivo móvel
- Acessar todos os apps cliente OAuth
- Instalar o app cliente OAuth
- Excluir app cliente OAuth
- Registrar o app OAuth
- Atualizar o app OAuth
- Invalidar tokens
- Ativar o usuário OAuth do app
- Desativar usuário do app OAuth
- Acessar a configuração do OIDC
- Atualizar configuração do OIDC
- Acessar a configuração de teste do OIDC
- Excluir configuração de teste do OIDC
- Criar configuração de teste do OIDC
- Acessar a configuração de senha
- Atualizar configuração de senha
- Forçar redefinição de senha
- Acessar configuração SAML
- Atualizar configuração SAML
- Acessar configuração de teste SAML
- Excluir configuração do teste SAML
- Criar configuração de teste SAML
- Analisar XML do IdP SAML
- Analisar URL do IdP SAML
- Acessar configuração da sessão
- Atualizar configuração da sessão
- Acessar usuários da lista de permissões de acesso ao suporte
- Adicionar usuários à lista de permissões de acesso ao suporte
- Excluir entrada da lista de permissões de acesso ao suporte
- Ativar o acesso ao suporte
- Desativar o acesso ao suporte
- Status de acesso ao suporte
- Bloqueios de login para todos os usuários
- Bloqueios de login do usuário da Pesquisa
- Excluir bloqueio de login do usuário
Placa
- Instalar todas as placas
- Criar placa
- Pesquisar painéis
- Instalar o tabuleiro
- Atualizar tabuleiro
- Excluir tabuleiro
- Obter todos os itens do tabuleiro
- Criar item do Board
- Adquirir item do tabuleiro
- Atualizar item do board
- Excluir item do board
- Obter todas as seções do tabuleiro
- Seção "Create Board"
- Seção "Get Board"
- Seção "Atualizar painel"
- Excluir seção do Jamboard
ColorCollection
- Receber todas as coleções de cores
- Criar ColorCollection
- Receber todas as coleções de cores personalizadas
- Receber todas as coleções de cores padrão
- Definir coleção de cores padrão
- Receber coleção de cores padrão
- Ver coleção de cores por ID
- Atualizar coleção de cores personalizadas
- Excluir ColorCollection
Configuração
- Instalar o Cloud Storage
- Atualizar o Cloud Storage
- Tenha um e-mail de boas-vindas personalizado
- Atualizar o conteúdo do e-mail de boas-vindas personalizado
- Envie um e-mail de boas-vindas ao usuário conectado com o conteúdo fornecido.
- Receber o resumo por e-mail
- Atualizar Digest_emails
- Enviar conteúdo do resumo por e-mail
- Endereços IP de saída pública
- Acessar conteúdo dos recursos de ajuda internos
- Atualizar o conteúdo dos recursos de ajuda internos
- Recursos de ajuda interna
- Atualizar a configuração dos recursos de ajuda internos
- Acessar todos os recursos legados
- Acessar o recurso legado
- Atualizar o recurso legado
- Ver todas as localidades
- Obter Mobile_Settings
- Definir configuração
- Configurações
- Definir configuração SMTP
- Receber status do SMTP
- Receber todos os fusos horários
- Conseguir ApiVersion
- Receber uma especificação da API
- Obter configuração de etiqueta em branco
- Atualizar configuração de etiqueta em branco
Conexão
- Receber todas as conexões
- Criar conexão
- Solicitar conexão
- Atualizar conexão
- Excluir conexão
- Excluir modificação de conexão
- Testar conexão
- Testar configuração de conexão
- Receber informações sobre o dialeto
- Obter todos os aplicativos OAuth externos
- Criar um aplicativo OAuth externo
- Crie o estado do usuário OAuth.
- Obter todos os servidores SSH
- Criar servidor SSH
- Obter servidor SSH
- Atualizar o servidor SSH
- Excluir servidor SSH
- Testar servidor SSH
- Obter todos os túneis SSH
- Criar túnel SSH
- Receber túnel SSH
- Atualizar túnel SSH
- Excluir túnel SSH
- Testar túnel SSH
- Gerar chave pública SSH
Conteúdo
- Pesquisar conteúdo favorito
- Ver conteúdo favorito
- Excluir conteúdo favorito
- Criar conteúdo favorito
- Buscar todos os metadados de conteúdo
- Atualizar metadados de conteúdo
- Acessar metadados de conteúdo
- Criar acesso de metadados de conteúdo
- Receber acesso a todos os metadados de conteúdo
- Atualizar o acesso aos metadados de conteúdo
- Excluir o acesso aos metadados de conteúdo
- Pesquisar conteúdo
- Acessar miniatura de conteúdo
- Validar conteúdo
- Pesquisar visualizações de conteúdo
- Usar a miniatura do vetor
Painel
- Acessar todos os painéis
- Criar painel
- Pesquisar painéis
- Importar painel do LookML
- Sincronizar painel do LookML
- Excluir painel
- Atualizar painel
- Instalar o painel
- Gerar LookML da tabela agregada em um painel
- Obter lookml de um UDD
- Mover painel
- Importar painel do LookML
- Criar painel com o LookML
- Copiar painel
- Pesquisar elementos do painel
- Instalar o DashboardElement
- Excluir DashboardElement
- Atualizar DashboardElement
- Acessar todos os DashboardElements
- Criar DashboardElement
- Obter painel de controle
- Excluir filtro do painel
- Atualizar filtro do painel
- Acessar todos os filtros do painel
- Criar filtro do painel
- Instalar DashboardLayoutComponent
- Atualizar DashboardLayoutComponent
- Acessar todos os DashboardLayoutComponents
- Instalar o DashboardLayout
- Excluir DashboardLayout
- Atualizar DashboardLayout
- Acessar todos os DashboardLayouts
- Criar DashboardLayout
Ação de dados
Datagroup
Tabela derivada
pasta.
Grupo
- Acessar todos os grupos
- Criar grupo
- Grupos de pesquisa
- Pesquisar grupos com funções
- Grupos de pesquisas com hierarquia
- Acessar o grupo
- Atualizar grupo
- Excluir grupo
- Acessar todos os grupos
- Adicionar um grupo ao grupo
- Reúna todos os usuários
- Adicionar um usuário ao grupo
- Remover um usuário do grupo
- Exclui um grupo do grupo
- Definir o valor do grupo de atributos do usuário
- Excluir valor do grupo de atributos do usuário
Página inicial
Integração
- Acessar todos os hubs de integração
- Criar hub de integração
- Instalar o Hub de integração
- Atualizar hub de integração
- Excluir o hub de integração
- Aceitar o contrato legal do Hub de integração
- Acessar todas as integrações
- Obter integração
- Atualizar integração
- Coletar formulário de integração remota
- Integração de testes
Look
Modelo de aparência
Metadados
- Sugestões de nome de campo do modelo
- Receber um único modelo
- Listar bancos de dados acessíveis com esta conexão
- Recursos de metadados compatíveis com esta conexão
- Acessar esquemas para uma conexão
- Ver tabelas de uma conexão
- Exibir colunas para uma conexão
- Pesquisar colunas em uma conexão
- Estimar custos para uma conexão
Projeto
- Bloquear tudo
- Receber todos os branches do Git
- Gerar ramificação Git ativa
- Conferir a nova ramificação do Git
- Atualizar ramificação do projeto Git
- Encontrar uma ramificação do Git
- Excluir uma ramificação do Git
- Implantar ramificação remota ou referência à produção
- Implantar para produção
- Redefinir para produção
- Redefinir para o modo remoto
- Acessar todos os projetos
- Criar projeto
- Acessar o projeto
- Atualizar projeto
- Acessar manifesto
- Criar chave de implantação
- Chave de implantação do Git
- Validar projeto
- Resultados de validação de projetos armazenados em cache
- Acessar o espaço de trabalho do projeto
- Acessar todos os arquivos do projeto
- Acessar o arquivo do projeto
- Receber todos os testes de conexão do Git
- Executar o teste de conexão Git
- Receber todos os testes do LookML
- Executar o LookML Test
- Ref. de tag
- Criar credencial do repositório
- Excluir credencial do repositório
- Acessar todas as credenciais do repositório
Consulta
- Executar Async Query
- Obter resultados de várias consultas assíncronas
- Obter informações de consulta assíncronas
- Receber resultados de consulta assíncrona
- Obter consulta
- Obter consulta para slug
- Criar consulta
- Executar consulta
- Executar consulta in-line
- Executar consulta codificada do URL
- Obter consulta mesclada
- Criar consulta mesclada
- Obter todas as consultas em execução
- Eliminar consultas em execução
- Receber consulta do SQL Runner
- Criar consulta do SQL Runner
- Executar consulta SQL Runner
RenderTask
Papel
- Conjuntos de modelos de pesquisa
- Receber conjunto de modelos
- Excluir conjunto de modelos
- Atualizar conjunto de modelos
- Receber todos os conjuntos de modelos
- Criar conjunto de modelos
- Obter todas as permissões
- Conjuntos de permissões de pesquisa
- Receber conjunto de permissões
- Excluir conjunto de permissões
- Atualizar conjunto de permissões
- Receber todos os conjuntos de permissões
- Criar conjunto de permissões
- Receber todas as funções
- Criar função
- Funções de pesquisa
- Funções de pesquisa com contagem de usuários
- Conseguir papel
- Excluir função
- Atualizar função
- Acessar grupos de papéis
- Atualizar grupos de papéis
- Conseguir usuários com função
- Atualizar usuários da função
Plano programado
- Planos programados para o espaço
- Excluir plano agendado
- Atualizar plano agendado
- Receber o plano agendado
- Criar plano programado
- Veja todos os planos programados
- Executar o plano agendado uma vez
- Planos programados para análise
- Planos programados para o painel
- Planos programados para o painel do LookML
- Executar o plano programado uma vez por ID
Sessão
Tema
Usuário
- Search CredentialsEmail
- Obter usuário atual
- Obter todos os usuários
- Criar usuário
- Pesquisar usuários
- Pesquisar nomes de usuários
- Receber usuário por ID
- Atualizar usuário
- Excluir usuário
- Receber usuário por ID de credencial
- Acessar credencial de e-mail/senha
- Criar credencial de e-mail/senha
- Atualizar credencial de e-mail/senha
- Excluir credencial de e-mail/senha
- Acessar credencial de dois fatores
- Criar credencial de dois fatores
- Excluir a credencial de dois fatores
- Acessar credencial LDAP
- Excluir credencial LDAP
- Acessar credencial do Google Auth
- Excluir credencial do Google Auth
- Gerar credencial do Saml Auth
- Excluir a credencial de autenticação do Saml
- Gerar credencial de autenticação do OIDC
- Excluir credencial de autenticação do OIDC
- Acessar credencial de API
- Excluir credencial da API
- Acessar todas as credenciais de API
- Criar credencial de API
- Acessar credencial de incorporação
- Excluir credencial de incorporação
- Receber todas as credenciais de incorporação
- Gerar credencial do OpenId do Looker
- Excluir credencial do Looker OpenId
- Acessar sessão de login na Web
- Excluir sessão de login na Web
- Acessar todas as sessões de login na Web
- Criar token de redefinição de senha
- Ver funções do usuário
- Definir funções do usuário
- Receber valores de atributo do usuário
- Definir valor do usuário do atributo do usuário
- Excluir valor do usuário do atributo do usuário
- Enviar token de redefinição de senha
- Excluir e-mails de usuários permanentemente
- Criar um usuário incorporado a partir de um ID de usuário externo
Atributo do usuário
Espaço de trabalho
Tipos
Nome
Alerta
- AlertFieldFilter.
- AlertAppliedDashboardFilter
- AlertField (em inglês)
- AlertConditionState.
- Alerta
- MobilePayload (em inglês)
- Alerta
- AlertDestination.
- Alerta
ApiAuth
Artefato
- ArtifactUsage
- ArtifactNamespace
- UpdateArtifact (em inglês)
- Artefato
Auth
- EmbedParams
- EmbedSsoParams
- EmbedCookielessSessionAcquire
- EmbedCookielessSessionAcquireResponse
- EmbedCookielessSessionGenerateTokens (link em inglês)
- EmbedCookielessSessionGenerateTokensResponse
- Incorporar Secret (em inglês)
- EmbedUrlResponse (em inglês)
- Group
- LDAPConfig (em inglês)
- LDAPConfigTestResult (em inglês)
- LDAPConfigTestIssue (em inglês)
- LDAPGroupRead (em inglês)
- LDAPGroupWrite (em inglês)
- LDAPUserAttributeRead (em inglês)
- LDAPUserAttributeWrite
- LDAPLDAP
- MobileToken (em inglês)
- ModelSet
- OauthClientApp (em inglês)
- OIDCConfig (em inglês)
- Leitura de grupo do OIDC
- OIDC do GroupWrite
- OIDCUserAttributeRead (em inglês)
- OIDCUserAttributeWrite (em inglês)
- PasswordConfig.
- PermissionSet.
- Papel
- SamlConfig (em inglês)
- SamlGroupRead (em inglês)
- SamlGroupWrite (em inglês)
- SamlMetadataParseResult (em inglês)
- SamlUserAttributeRead (em inglês)
- SamlUserAttributeWrite (link em inglês)
- SessionConfig.
- SupportAccessAllowlistEntry
- SupportAccessAddEntries (em inglês)
- SupportAccessEnable
- SupportAccessStatus (em inglês)
- UserAttribute.
- UserLoginLockout (em inglês)
- UserPublic (em inglês)
Placa
- BoardItem (em inglês)
- Placa
- Seção de seções
ColorCollection
- ColorStop
- ContinuousPalette
- DiscretePalette (em inglês)
- ColorCollection
Configuração
- BackupConfiguration (em inglês)
- CustomWelcomeEmail.
- DigestEmailSend.
- E-mails de compilação
- Endereços de saída
- Configurações do Smtp
- InternalHelpResourcesContent
- Recursos de ajuda internos
- Recurso legado
- Locale
- Configurações de dispositivos móveis
- MobileFeatureFlags (em inglês)
- Configuração
- SmtpStatus (em inglês)
- SmtpNodeStatus (em inglês)
- Fuso horário
- ApiVersionElement (link em inglês)
- Versão da API
- WelcomeEmailTest
- WhitelabelConfiguration
- PrivatelabelConfiguration
Conexão
- CreateOAuthApplicationUserStateRequest (em inglês)
- CreateOAuthApplicationUserStateResponse (em inglês)
- DBConnection (em inglês)
- DBConnectionOverride.
- DBConnectionTestResult.
- DialectInfo (em inglês)
- DialectInfoOptions (em inglês)
- Dialeto
- ExternalOauthApplication (em inglês)
- Snippet
- SshPublicKey (em inglês)
- SshServer (em inglês)
- SshTunnel
Conteúdo
- DashboardBase
- ContentFavorite
- ContentMetaGroupUser (em inglês)
- MetaMeta
- Pesquisa de conteúdo
- ContentValidation (em inglês)
- ContentValidatorError.
- ContentValidationFolder (em inglês)
- ContentValidationLook (em inglês)
- ContentValidationDashboard (em inglês)
- ContentValidationDashboardElement (em inglês)
- ContentValidationError.
- ContentValidationDashboardFilter (em inglês)
- ContentValidationScheduledPlan.
- ContentValidationAlert.
- Painel ContentValidationLookML
- ContentValidationLookMLDashboardElement (em inglês)
- ContentView.
- PastaBase
- LookBasic
- LookModel
Painel
- DashboardBase
- DashboardAggregateTableLookml (em inglês)
- Aparência do painel
- DashboardElement (em inglês)
- DashboardFilter (em inglês)
- CreateDashboardFilter
- DashboardLayoutComponent
- PainelLayout
- DashboardLookml
- Painel
- PastaBase
- LookWithQuery (link em inglês)
- LookModel
- Consulta
- ResultMakerFilterablesListen.
- ResultMakerFilterables (em inglês).
- ResultMakerWithIdVisConfigAndDynamicFields.
Ação de dados
Datagroup
Tabela derivada
- DependencyGraph
- MaterializePDT (em inglês)
pasta.
- DashboardBase
- Aparência do painel
- DashboardElement (em inglês)
- DashboardFilter (em inglês)
- DashboardLayoutComponent
- PainelLayout
- Painel
- PastaBase
- Criar pasta
- UpdateFolder (em inglês)
- Pasta
- LookWithQuery (link em inglês)
- LookWithDashboards
- LookModel
- Consulta
- ResultMakerFilterablesListen.
- ResultMakerFilterables (em inglês).
- ResultMakerWithIdVisConfigAndDynamicFields.
Grupo
- CredentialsApi3 (em inglês)
- CredentialsEmail (em inglês)
- CredentialsEmbed (em inglês)
- CredentialsGoogle
- CredentialsLDAP (em inglês)
- CredentialsLookerOpenid (em inglês)
- CredenciaisOIDC
- CredentialsSaml (em inglês)
- CredentialsTotp (em inglês)
- GroupIdForGroupInclusion
- Group
- Pesquisa de grupo
- GroupHierarchy
- GroupIdForGroupUserInclusion
- ModelSet
- PermissionSet.
- Papel
- Sessão
- UserAttributeGroupValue.
- User
Página inicial
Integração
Look
- PastaBase
- Olhar
- LookWithQuery (link em inglês)
- LookModel
- Consulta
Modelo de aparência
- LookmlModelNavExplore (link em inglês)
- LookmlModelExplore (em inglês)
- LookmlModelExploreSupportedMeasureType
- LookmlModelExploreAccessFilter.
- LookmlModelExploreConditionlyFilter
- LookmlModelExploreAlwaysFilter
- LookmlModelExploreAlias (link em inglês)
- LookmlModelExploreSet (em inglês)
- LookmlModelExploreError.
- LookmlModelExploreFieldset (em inglês)
- LookmlModelExploreField (em inglês)
- LookmlModelExploreFieldEnumeration
- LookmlModelExploreFieldTimeInterval
- LookmlModelExploreFieldSqlCase (em inglês)
- LookmlModelExploreFieldMeasureFilters
- LookmlModelExploreFieldMapLayer
- LookmlModelExploreJoins (link em inglês)
- LookmlModel
Metadados
Projeto
- GitBranch (em inglês)
- GitConnectionTest (em inglês)
- GitConnectionTestResult (em inglês)
- GitStatus (em inglês)
- ImportedProject
- LocationSettings
- LookmlTest (em inglês)
- LookmlTestResult (em inglês)
- Manifesto
- ProjectFile (em inglês)
- Projeto
- ProjectError.
- ModelosNotValidated
- ProjectValidation
- ProjectValidationCache.
- ProjectWorkspace
- RepositoryCredential (em inglês)
Consulta
- DBConnectionBase (em inglês)
- Dialeto
- LookBasic
- MergeQuery.
- MesclarQuerySourceQuery
- MergeFields.
- Consulta
- CreateQueryTask
- QueryTask
- Como executar consultas
- Snippet
- SqlQueryCreate.
- SqlQuery (em inglês)
- UserPublic (em inglês)
RenderTask
Papel
- CredentialsApi3 (em inglês)
- CredentialsEmail (em inglês)
- CredentialsEmbed (em inglês)
- CredentialsGoogle
- CredentialsLDAP (em inglês)
- CredentialsLookerOpenid (em inglês)
- CredenciaisOIDC
- CredentialsSaml (em inglês)
- CredentialsTotp (em inglês)
- Group
- ModelSet
- Permissão
- PermissionSet.
- Papel
- RoleSearch (em inglês)
- Sessão
- User
Plano programado
- ScheduledPlanDestination (em inglês)
- WriteScheduledPlan (em inglês)
- Programado
- UserPublic (em inglês)
Sessão
Tema
- ThemeSettings (em inglês)
- Tema
Usuário
- CreateEmbedUserRequest
- CredentialsApi3 (em inglês)
- CreateCredentialsApi3 (em inglês)
- CredentialsEmail (em inglês)
- CredentialsEmailSearch.
- CredentialsEmbed (em inglês)
- CredentialsGoogle
- CredentialsLDAP (em inglês)
- CredentialsLookerOpenid (em inglês)
- CredenciaisOIDC
- CredentialsSaml (em inglês)
- CredentialsTotp (em inglês)
- ModelSet
- PermissionSet.
- Papel
- Sessão
- UserAttributeWithValue (em inglês)
- UserEmailOnly (em inglês)
- User
- UserPublic (em inglês)
Atributo do usuário
Espaço de trabalho
Versões
A versão mais recente da API é 4.0.23.6. Você está vendo os documentos da versão mais recente.
Os documentos também estão disponíveis para versões anteriores compatíveis: