Documentação Técnica

API de Views

Uma View é um agrupamento customizado de datasets e atributos com um nome simplificado atribuído. As views permitem uma simplificação do processo de consulta, na medida em que uma URL complexa pode ser traduzida em um nome simples, facilitando o processo de integração.

As views permitem, também, a construção de agrupamentos lógicos de consulta com base nas funcionalidades ou nos objetivos que se deseja alcançar, traduzindo a complexidade de uma query em um único nome que explica o objetivo e simplifica a leitura das informações.

Uma vez definida, a view está disponível para o próprio usuário que a criou e para todos os usuários que pertençam a mesma empresa.

Exemplo: Enriquecimento de Leads

Imagine que você está estruturando um processo de enriquecimento de dados para apoiar os representantes comerciais da sua empresa. Nesse processo, todo lead que entra no seu CRM precisa ser enriquecido com o nome e data de nascimento da pessoa, além de dados de contato, mas apenas telefones celulares e e-mails profissionais, e apenas o contato principal. A query para realizar esse enriquecimento normalmente seria:

Body:
{
    "datasets": "basic_data{name, birthdate},addresses.limit(1),emails.filter(type=WORK).limit(1),phones.filter(type=MOBILE).limit(1)",
    "q": "doc{xxxxxxxxxxxxxx}"
}

No entanto, você pode agrupar todos esses datasets em uma view chamada "enriquecimento_leads". Dessa forma, a query, na hora de buscar os dados, ficaria simplificada, conforme o exemplo abaixo:

Body:
{
    "View": "enriquecimento_leads",
    "q": "doc{xxxxxxxxxxxxxx}"
}

Assim, a complexidade de seleção dos datasets e filtragem fica abstraída, e quem estiver utilizando a view entende o propósito a que ela serve sem ter que enviar a query mais complexa.

❗️

Não existe custo associado com a criação, manutenção ou remoção de views.
O custo da consulta a uma view é equivalente ao custo de consultar todos os datasets que estão configurados na mesma.

As seções a seguir descrevem as diferentes operações disponíveis na API de Views.