O Droz Bot disponibiliza uma API de rastreamento (Tracking API) que permite extrair dados analíticos dos bots diretamente para sistemas externos de Business Intelligence, dashboards personalizados ou integrações com outras plataformas.
O acesso à documentação completa fica disponível dentro do painel do bot, na aba Dashboard → API, com os endpoints organizados por controlador e filtráveis por período.
Autenticação
Para utilizar qualquer endpoint da Tracking API é necessário gerar um token de autenticação com validade de 24 horas.
 |
Endpoint de autenticaçãoPOST https://admin-api.meudroz.com/authenticate/track
|
 |
Validade do token 24 horas. Após esse prazo, um novo token precisa ser gerado. |
Exemplo de requisição:
var Http = new XMLHttpRequest();
var url = 'https://admin-api.meudroz.com/authenticate/track';
Http.open('POST', url);
Http.setRequestHeader('Content-Type', 'application/json');
Http.send(JSON.stringify({
'email': 'seu@email.com',
'password': '********'
}))| ⚠️ Nunca exponha o e-mail e senha de autenticação em código cliente ou repositórios públicos. Utilize variáveis de ambiente ou cofres de segredos para armazenar essas credenciais. |
Base URL
Todos os endpoints da Tracking API utilizam a seguinte base:
https://tracking-api.meudroz.com
A documentação interativa completa (Swagger) está disponível em:
https://tracking-api.meudroz.com/v3/api-docs?group=tracking
Controladores disponíveis
 |
dashboard-controller Endpoints de métricas e relatórios dos atendimentos do bot: volume, retenção, tempo médio, feedbacks, etapas, transbordos e downloads. |
 |
account-controller Endpoints de dados da conta: informações consolidadas, conectores, histórico de conversas e relatórios por período. |
 |
tracking-bot-controller Endpoints de rastreamento específico por bot: histórico de conversas, usuários online e versões de histórico. |
dashboard-controller
Endpoints para extração de métricas analíticas dos atendimentos. Todos utilizam os parâmetros {botId}, {dateFrom} e {dateTo}.
GET/dashboard/accesses/bot/{{botId}}/{{dateFrom}}/{{dateTo}}
|
Retorna todos os atendimentos |
GET/dashboard/atendimentos/bot/{{botId}}/{{dateFrom}}/{{dateTo}}/attendanceByDate
|
Volume de atendimentos agrupado por data |
GET/dashboard/atendimentos/bot/{{botId}}/{{dateFrom}}/{{dateTo}}/attendanceByTime
|
Volume de atendimentos agrupado por horário |
GET/dashboard/atendimentos/bot/{{botId}}/{{dateFrom}}/{{dateTo}}/averageTalkTimeIndicator
|
Tempo médio de atendimento (indicador) |
GET/dashboard/atendimentos/bot/{{botId}}/{{dateFrom}}/{{dateTo}}/averageTimeTalk
|
Evolução do tempo médio de atendimento ao longo do período |
GET/dashboard/atendimentos/bot/{{botId}}/{{dateFrom}}/{{dateTo}}/deviceIndicatorInteractions
|
Interações segmentadas por tipo de dispositivo |
GET/dashboard/atendimentos/bot/{{botId}}/{{dateFrom}}/{{dateTo}}/evolutionInteractions
|
Evolução do número de interações ao longo do período |
GET/dashboard/atendimentos/bot/{{botId}}/{{dateFrom}}/{{dateTo}}/evolutionInteractionsUser
|
Evolução do número de interações por usuário |
GET/dashboard/atendimentos/bot/{{botId}}/{{dateFrom}}/{{dateTo}}/total
|
Número total de atendimentos e engajamento |
GET/dashboard/atendimentos/bot/{{botId}}/{{dateFrom}}/{{dateTo}}/total/abandoned
|
Número total de atendimentos abandonados |
GET/dashboard/atendimentos/bot/{{botId}}/{{dateFrom}}/{{dateTo}}/total/chats
|
Número total de atendimentos e engajamento |
GET/dashboard/atendimentos/bot/{{botId}}/{{dateFrom}}/{{dateTo}}/total/chatsOpen
|
Total geral — cliques no bot |
GET/dashboard/atendimentos/bot/{{botId}}/{{dateFrom}}/{{dateTo}}/total/evolutionRetention
|
Evolução da taxa de retenção ao longo do período |
GET/dashboard/atendimentos/bot/{{botId}}/{{dateFrom}}/{{dateTo}}/total/finishedChat
|
Total de chats finalizados |
GET/dashboard/atendimentos/bot/{{botId}}/{{dateFrom}}/{{dateTo}}/total/finishedChats/byType
|
Total de chats finalizados por tipo |
GET/dashboard/atendimentos/bot/{{botId}}/{{dateFrom}}/{{dateTo}}/total/finishedNoRetention
|
Total de atendimentos finalizados sem retenção |
GET/dashboard/atendimentos/bot/{{botId}}/{{dateFrom}}/{{dateTo}}/total/interactedChats
|
Evolução do engajamento ao longo do período e por dia |
GET/dashboard/atendimentos/bot/{{botId}}/{{dateFrom}}/{{dateTo}}/total/noRetention
|
Total de atendimentos sem retenção |
GET/dashboard/atendimentos/bot/{{botId}}/{{dateFrom}}/{{dateTo}}/total/openTicket
|
Total de atendimentos que geraram criação de ticket para atendimento humano |
GET/dashboard/atendimentos/bot/{{botId}}/{{dateFrom}}/{{dateTo}}/total/redirectChat
|
Total de atendimentos transferidos para outro bot |
GET/dashboard/atendimentos/bot/{{botId}}/{{dateFrom}}/{{dateTo}}/total/retentionInteractedChats
|
Retidos e não retidos — base para cálculo da média dos chats retidos |
GET/dashboard/atendimentos/bot/{{botId}}/{{dateFrom}}/{{dateTo}}/total/retentionPoint
|
Total de pontos de retenção no fluxo |
GET/dashboard/atendimentos/bot/{{botId}}/{{dateFrom}}/{{dateTo}}/total/transferredChat
|
Total de chats transferidos |
GET/dashboard/atendimentos/bot/{{botId}}/dashboard/total/realTimeChats
|
Clientes online no momento |
POST/dashboard/atendimentos/bot/{{botId}}/download/{{dateFrom}}/{{dateTo}}/chats
|
Download das conversas (CSV) |
GET/dashboard/atendimentos/bot/{{botId}}/download/{{dateFrom}}/{{dateTo}}/feedbacks/negatives
|
Download dos feedbacks negativos (CSV) |
POST/dashboard/atendimentos/bot/{{botId}}/download/talks/realTimeChats
|
Download das conversas online (CSV) |
POST/dashboard/atendimentos/bot/{{botId}}/feedback/download/{{dateFrom}}/{{dateTo}}/{{popup}}
|
Download das respostas do componente de feedback (CSV) |
GET/dashboard/atendimentos/bot/{{botId}}/talk/{{talkId}}/history
|
Histórico da conversa |
GET/dashboard/atendimentos/etapas/{{botId}}/{{dateFrom}}/{{dateTo}}
|
Relatório de acesso por etapas |
GET/dashboard/atendimentos/etapas/old/{{botId}}/{{dateFrom}}/{{dateTo}}
|
Relatório de acesso por etapas — versão antiga |
GET/dashboard/atendimentos/etapas/retention/{{botId}}/{{dateFrom}}/{{dateTo}}
|
Retenção por etapas |
GET/dashboard/atendimentos/feedback-comments-popup/{{botId}}/{{dateFrom}}/{{dateTo}}/{{order}}
|
Avaliação de atendimento — comentário |
GET/dashboard/atendimentos/feedback-comments-type/{{type}}/{{botId}}/{{dateFrom}}/{{dateTo}}
|
Avaliação de atendimento — comentário filtrado por tipo |
GET/dashboard/atendimentos/feedback-comments/{{botId}}/{{dateFrom}}/{{dateTo}}
|
Avaliação de atendimento — feedback |
GET/dashboard/atendimentos/feedback-popup/{{botId}}/{{dateFrom}}/{{dateTo}}/total
|
Total de exibição do componente de feedback |
GET/dashboard/atendimentos/feedback/{{botId}}/{{dateFrom}}/{{dateTo}}/{{popup}}
|
Indicador médio do componente de feedback por dia |
GET/dashboard/atendimentos/infos/{{botId}}/{{dateFrom}}/{{dateTo}}
|
Informações gerais de atendimento no período |
GET/dashboard/atendimentos/infos/{{botId}}/{{dateFrom}}/{{dateTo}}/total/group/unique
|
Acessos únicos — usuários |
GET/dashboard/atendimentos/transbordos/{{botId}}/{{dateFrom}}/{{dateTo}}
|
Relatório de transbordo |
account-controller
Endpoints para acesso a dados da conta, conectores e relatórios consolidados.
GET/account
|
Dados gerais da conta autenticada |
GET/account/all/{{dateFrom}}/{{dateTo}}
|
Retorna todas as contas/registros no período informado |
GET/account/captcha
|
Gera captcha para validação de acesso |
GET/account/checkToken
|
Valida se o token de autenticação ainda está ativo |
GET/account/connector
|
Lista os conectores configurados na conta |
GET/account/connector/{{accountConnectorId}}
|
Detalha um conector específico da conta |
GET/account/connector/errors
|
Lista os erros registrados nos conectores da conta |
GET/account/historyjson/{{talkId}}
|
Retorna o histórico de uma conversa em formato JSON |
GET/account/infos/{{month}}/{{year}}
|
Informações consolidadas da conta no mês/ano informado |
GET/account/infos/{{month}}/{{year}}/bot/{{botId}}
|
Informações consolidadas de um bot específico no mês/ano informado |
GET/account/infos/{{month}}/{{year}}/bots
|
Informações consolidadas de todos os bots no mês/ano informado |
GET/account/infos/bot/talk/evolution
|
Evolução do volume de conversas por bot |
GET/account/infos/franquia
|
Informações de consumo/franquia da conta |
GET/account/infos/franquia/monthly
|
Informações de consumo/franquia da conta por mês |
GET/account/page
|
Lista as contas de forma paginada |
GET/account/report/{{month}}/{{year}}/account/{{accountEnable}}
|
Relatório da conta por mês/ano filtrado por status (ativa/inativa) |
GET/account/self
|
Dados da conta atualmente autenticada |
tracking-bot-controller
Endpoints para rastreamento de conversas e usuários de um bot específico.
GET/account/bot/{{botId}}/history/{{talkId}}
|
Histórico de uma conversa específica do bot |
GET/account/bot/{{botId}}/history/{{talkId}}/new
|
Histórico de uma conversa específica do bot — versão nova |
GET/account/bot/{{botId}}/history/talks
|
Histórico de todas as conversas do bot |
GET/account/bot/{{botId}}/talk/users-online
|
Usuários online em conversa com o bot no momento |
💡 A documentação Swagger com todos os parâmetros, exemplos de resposta e possibilidade de execução direta está disponível no painel do bot em Dashboard → API, ou acessando https://tracking-api.meudroz.com/v3/api-docs?group=tracking.
|