API de relatórios do Droz Bot: leve os dados do Dashboard para o seu BI – Droz | Central de Ajuda

Os números do Dashboard do Droz Bot, como volume de atendimentos, retenção, feedbacks e transbordos, também podem ser lidos por uma API, a Tracking API. Com ela, você leva esses dados para uma ferramenta de BI, uma planilha ou um painel próprio, sem exportar relatório à mão.

Para usar, você precisa de três coisas:

O e-mail e a senha de um usuário com acesso ao painel do bot.
O ID do bot que você quer consultar. É o número que aparece no endereço do painel quando você abre o bot: em admin.meudroz.com/#/account/bot/1234/history, o ID é 1234.
Alguém que saiba fazer chamadas HTTP, ou uma ferramenta de BI que faça isso por você.

1. Gere o token de acesso

Toda chamada à API precisa de um token. Para gerar um, envie o e-mail e a senha para o endereço de autenticação:

curl -X POST https://admin-api.meudroz.com/authenticate/track \
  -H "Content-Type: application/json" \
  -d '{"email": "voce@empresa.com", "password": "SUA_SENHA"}'

O token vem no campo loggedUser.token da resposta. Se o e-mail ou a senha estiverem errados, o campo statusCode volta como WRONG_CREDENTIALS.

{
  "statusCode": "EMAIL_CONFIRMED",
  "loggedUser": {
    "token": "eyJhbGciOiJIUzUxMiJ9...",
    ...
  }
}

O token vale por 24 horas. Para saber se ele ainda está ativo, chame GET /account/checkToken. Numa integração automática, o mais simples é gerar um token novo no começo de cada execução.

⚠️ Faça a autenticação num servidor, nunca em código que roda no navegador: quem abrir a página consegue ver o e-mail e a senha. Guarde as credenciais numa variável de ambiente ou num cofre de segredos, e não as coloque em repositórios.

2. Faça a primeira consulta

Todos os relatórios ficam em https://tracking-api.meudroz.com. Envie o token no cabeçalho Authorization, depois da palavra Bearer, e escreva as datas no formato AAAA-MM-DD.

Este exemplo busca o total de atendimentos do bot 1234 em setembro de 2026:

curl https://tracking-api.meudroz.com/dashboard/atendimentos/bot/1234/2026-09-01/2026-09-30/total \
  -H "Authorization: Bearer SEU_TOKEN"

A resposta vem em JSON. Se voltar o erro 401, o token está faltando ou já venceu: gere outro.

3. Escolha o relatório

Nos endereços abaixo, troque {botId} pelo ID do bot e {dateFrom} e {dateTo} pelas datas de início e fim do período. Os endereços que começam com /total ou outro trecho curto continuam o caminho /dashboard/atendimentos/bot/{botId}/{dateFrom}/{dateTo}.

Volume e engajamento

Endereço	O que retorna
`GET …/total`	Total de atendimentos e engajamento
`GET …/total/chats`	Total de conversas
`GET …/total/chatsOpen`	Cliques no bot, ou seja, quantas vezes o chat foi aberto
`GET …/total/interactedChats`	Engajamento no período e por dia
`GET …/attendanceByDate`	Atendimentos por dia
`GET …/attendanceByTime`	Atendimentos por horário
`GET …/evolutionInteractions`	Evolução das interações no período
`GET …/evolutionInteractionsUser`	Evolução das interações por usuário
`GET …/deviceIndicatorInteractions`	Interações por tipo de dispositivo
`GET …/averageTalkTimeIndicator`	Tempo médio de atendimento
`GET …/averageTimeTalk`	Evolução do tempo médio de atendimento
`GET /dashboard/atendimentos/infos/{botId}/{dateFrom}/{dateTo}`	Informações gerais dos atendimentos
`GET /dashboard/atendimentos/infos/{botId}/{dateFrom}/{dateTo}/total/group/unique`	Usuários únicos
`GET /dashboard/atendimentos/{botId}/{dateFrom}/{dateTo}`	Lista dos atendimentos do período
`GET /dashboard/accesses/bot/{botId}/{dateFrom}/{dateTo}`	Acessos ao bot no período
`GET /dashboard/atendimentos/bot/{botId}/dashboard/total/realTimeChats`	Clientes online agora (não usa datas)

Retenção e encerramento

Endereço	O que retorna
`GET …/total/retention-analysis`	Todos os indicadores de retenção numa chamada só: aberturas, abandonos, tickets, transferências, finalizados e pontos de retenção
`GET …/total/retentionInteractedChats`	Retidos e não retidos, base da média de chats retidos
`GET …/total/evolutionRetention`	Evolução da taxa de retenção
`GET …/total/retentionPoint`	Pontos de retenção no fluxo
`GET …/total/noRetention`	Atendimentos sem retenção
`GET …/total/finishedNoRetention`	Atendimentos finalizados sem retenção
`GET …/total/abandoned`	Atendimentos abandonados
`GET …/total/finishedChat`	Chats finalizados
`GET …/total/finishedChats/byType`	Chats finalizados, separados por tipo
`GET /dashboard/atendimentos/etapas/retention/{botId}/{dateFrom}/{dateTo}`	Retenção em cada etapa do fluxo

Transbordo e transferência

Endereço	O que retorna
`GET …/total/openTicket`	Atendimentos que abriram ticket para atendimento humano
`GET …/total/transferredChat`	Chats transferidos
`GET …/total/redirectChat`	Atendimentos enviados para outro bot
`GET /dashboard/atendimentos/transbordos/{botId}/{dateFrom}/{dateTo}`	Relatório de transbordo

Etapas do fluxo

Endereço	O que retorna
`GET /dashboard/atendimentos/etapas/{botId}/{dateFrom}/{dateTo}`	Acessos em cada etapa do fluxo. O parâmetro `language` é obrigatório.
`GET /dashboard/atendimentos/etapas/old/{botId}/{dateFrom}/{dateTo}`	O mesmo relatório no formato antigo

Feedback

O parâmetro {popup} recebe true ou false.

Endereço	O que retorna
`GET /dashboard/atendimentos/feedback/{botId}/{dateFrom}/{dateTo}/{popup}`	Nota média do componente de feedback, dia a dia
`GET /dashboard/atendimentos/feedback-popup/{botId}/{dateFrom}/{dateTo}/total`	Quantas vezes o componente de feedback apareceu
`GET /dashboard/atendimentos/feedback-comments/{botId}/{dateFrom}/{dateTo}`	Comentários das avaliações, em páginas (`page` e `count`)
`GET /dashboard/atendimentos/feedback-comments-type/{type}/{botId}/{dateFrom}/{dateTo}`	Comentários de um tipo de avaliação
`GET /dashboard/atendimentos/feedback-comments-popup/{botId}/{dateFrom}/{dateTo}/{order}`	Comentários do componente de feedback, na ordem escolhida

Arquivos para baixar (CSV)

Endereço	O que retorna
`POST /dashboard/atendimentos/bot/{botId}/download/{dateFrom}/{dateTo}/chats`	Conversas do período
`GET /dashboard/atendimentos/bot/{botId}/download/{dateFrom}/{dateTo}/feedbacks/negatives`	Feedbacks negativos
`POST /dashboard/atendimentos/bot/{botId}/feedback/download/{dateFrom}/{dateTo}/{popup}`	Respostas do componente de feedback
`POST /dashboard/atendimentos/bot/{botId}/download/talks/realTimeChats`	Conversas acontecendo agora

Histórico de conversas

Endereço	O que retorna
`GET /account/bot/{botId}/history/talks`	Lista das conversas do bot. Aceita filtros como `dateFrom`, `dateTo`, `name`, `email` e `externalId`, além de `page` e `count`
`GET /account/bot/{botId}/history/{talkId}`	Uma conversa inteira
`GET /account/bot/{botId}/history/{talkId}/new`	Uma conversa inteira, no formato novo
`GET /dashboard/atendimentos/bot/{botId}/talk/{talkId}/history`	Histórico de uma conversa, como aparece no Dashboard
`GET /account/historyjson/{talkId}`	Uma conversa em JSON
`GET /account/bot/{botId}/talk/users-online`	Usuários conversando com o bot agora

Conta e consumo

Endereço	O que retorna
`GET /account/self`	Dados da conta do usuário autenticado
`GET /account/infos/{month}/{year}/bots`	Resumo de todos os bots no mês
`GET /account/infos/{month}/{year}/bot/{botId}`	Resumo de um bot no mês
`GET /account/infos/{month}/{year}`	Resumo da conta no mês
`GET /account/infos/bot/talk/evolution`	Evolução do volume de conversas por bot
`GET /account/infos/franquia`	Consumo da franquia
`GET /account/infos/franquia/monthly`	Consumo da franquia mês a mês
`GET /account/connector`	Conectores configurados na conta
`GET /account/connector/{accountConnectorId}`	Detalhes de um conector
`GET /account/connector/errors`	Erros registrados nos conectores
`GET /account/checkToken`	Confere se o token ainda está ativo

Veja todos os parâmetros na documentação

A documentação completa, com cada parâmetro e o formato das respostas, fica no painel do bot em Dashboard > API.

Pesquisa