Documentation Index
Fetch the complete documentation index at: https://docs.lovi.ai/llms.txt
Use this file to discover all available pages before exploring further.
Documentação oficial para extração de dados brutos do banco de dados
Este documento tem como objetivo fornecer acesso e uma descrição das principais estruturas de dados disponíveis para a empresa, a fim de facilitar a integração adequada, gestão e análise de informações relacionadas às interações e agentes participantes. Além de descrever a estrutura de cada tabela, inclui recomendações e avisos sobre o tratamento responsável de dados pessoais que podem ser encontrados nos registros, destacando a importância de cumprir as regulamentações vigentes de privacidade e segurança da informação. Sugerimos revisar cuidadosamente a definição de cada campo e as notas sobre o tratamento de dados pessoais antes de iniciar qualquer processo de integração ou análise, para garantir o uso seguro e adequado do banco de dados fornecido.Acesso aos Dados no ClickHouse via HTTP e Ferramentas de BI
Esta seção explica como se conectar ao banco de dados ClickHouse da Botslovers, seja por acesso HTTP direto (por exemplo, usandocurl) ou por meio de ferramentas gráficas e ferramentas de Business Intelligence como DBeaver, Power BI ou Tableau.
Acesso via HTTP (exemplo usando curl)
Você pode acessar os dados executando consultas SQL diretamente no banco de dados ClickHouse por meio de sua interface HTTP. Exemplo Básico: Para recuperar os primeiros 10 registros da tabelamessages_<company>:
user e password pelas suas credenciais pessoais.
O parâmetro
query deve ser codificado em URL.FORMAT ao final da consulta:
Exemplo JSON:
Acesso a partir de Ferramentas de BI ou Clientes de Banco de Dados (DBeaver, Power BI, Tableau, etc.)
O ClickHouse suporta conectores JDBC e ODBC, permitindo que você use ferramentas gráficas para explorar e analisar os dados.Acesso via DBeaver
- Abra o DBeaver e crie uma nova conexão.
- Selecione ClickHouse como tipo de banco de dados.
- Escolha HTTP como tipo de conexão.
- Preencha os seguintes campos:
- Host:
public-clickhouse.botslovers.com - Porta:
443 - Usuário: seu nome de usuário
- Senha: sua senha
- SSL: habilitado (certifique-se de que a caixa está marcada)
- Host:
- Teste a conexão e salve.
Acesso a partir de Ferramentas de BI (Power BI, Tableau, etc.)
Power BI- Baixe e instale o driver ODBC oficial do ClickHouse.
- Configure um DSN ODBC apontando para:
- Host:
public-clickhouse.botslovers.com - Porta:
443(ou8443dependendo da configuração, consulte seu administrador) - Modo SSL: habilitado
- Usuário/Senha: suas credenciais
- Host:
- No Power BI, crie uma nova fonte de dados ODBC e selecione o DSN configurado.
- Você pode usar o driver ODBC do ClickHouse como no Power BI.
- Alternativamente, use o conector nativo do ClickHouse.
Segurança e Boas Práticas
- Suas credenciais são pessoais e não devem ser compartilhadas.
- Consulte seu administrador se tiver dúvidas sobre limites de uso ou estrutura de dados.
- Recomendamos evitar consultas que extraiam grandes volumes de dados para prevenir possíveis problemas de desempenho do serviço.
Tabelas
messages
Funciona como o repositório central onde cada mensagem individual gerada em uma conversa é armazenada. Este documento detalha seus campos, finalidade e recomendações específicas para o gerenciamento seguro de dados sensíveis.
agent_activity
Tabelas que concentram informações relevantes sobre agentes — humanos ou automatizados — que participam de conversas. Facilitam a associação de eventos e métricas a cada agente para análise de atividade individual, cálculos de indicadores-chave (ex.: tempos de resposta, fechamentos de sessão, disponibilidade do agente) e rastreabilidade de ações entre conversas, mesmo quando ocorrem transferências.
Descrição das Tabelas
messages (Tabela: messages_<company>)
Armazena todas as mensagens trocadas durante as conversas.
| Campo | Tipo | Descrição |
|---|---|---|
sender_id | String | Identificador único do remetente, vinculando cada mensagem a uma entidade específica. |
sender_type | String | Origem da mensagem: "user", "bot", "system" ou "human". |
id | String | Chave única de cada mensagem, garantindo a detecção de duplicatas. |
created_at | DateTime | Timestamp em UTC de quando a mensagem foi gerada. |
channel | String | Canal pelo qual a mensagem foi enviada: "whatsapp" ou "web" (widget). |
session | String | Identificador da conversa agrupando múltiplas mensagens. |
direction | String | Direção da mensagem: "inbound" ou "outbound". |
type | String | Tipo comunicativo: "inbound" (recebida) ou "outbound" (enviada). |
text | String | Conteúdo completo em texto livre da mensagem. Pode incluir texto, emojis, e-mails, IDs, etc. Nota: Pode ser null para imagens ou documentos. |
language | String | Código do idioma (ex.: "es", "en"). Nota: Pode ser null se não detectado. |
agent_activity (Tabela: chat_agent_log_<company>)
Registra eventos que ocorrem durante a interação dos agentes com os chats.
| Campo | Tipo | Descrição |
|---|---|---|
id | String | Identificador único do evento. |
chat_id | String | Identificador do chat associado. |
agent_id | String | Identificador único do agente envolvido no evento. |
joined_at | DateTime | Timestamp em UTC de quando o agente entrou no chat. |
left_at | Nullable(DateTime) | Timestamp em UTC de quando o agente saiu do chat, ou null se ainda ativo. |
event | String | Tipo de evento. Valores possíveis: bot_assigned, agent_timeout, user_timeout, agent_joined, chat_escalated, manual_close, resolved, assigned_to_human, transferred. |
response_rating | Nullable(Int16) | Avaliação dada para a interação, se houver. |
created_at | DateTime | Timestamp de criação do registro. |
updated_at | DateTime | Timestamp da última atualização do registro. |
deleted_at | Nullable(DateTime) | Timestamp de exclusão lógica, se aplicável. |
agent_status_logs (Tabela: agent_status_logs_<company>)
Rastreia o histórico de mudanças de status dos agentes ao longo do tempo, como a transição de “online” para “break”.
| Campo | Tipo | Descrição |
|---|---|---|
id | String | Identificador único da mudança de status. |
agent_id | String | Identificador único do agente. |
old_status | String | Status anterior do agente: training, offline, break, ending_shift, inactive, online. |
new_status | String | Novo status do agente: training, offline, break, ending_shift, inactive, online. |
status_changed_at | DateTime | Timestamp em UTC de quando o status mudou. |
duration_seconds | Nullable(Int64) | Duração em segundos do status anterior, ou null se não aplicável. |
created_at | DateTime | Timestamp de criação do registro. |
Tratamento de Dados Pessoais
A tabelamessages_ , especialmente a coluna text, retém o conteúdo completo das interações com os clientes, podendo conter dados pessoais como nomes, endereços de e-mail, números de identificação ou outros detalhes sobre os produtos ou serviços oferecidos pela sua empresa.
É essencial processar esses dados de acordo com as regulamentações aplicáveis, mantendo sempre a confidencialidade, segurança e os direitos dos titulares dos dados.