Docs/API Reference/Analytics
DashboardGitHub

Os endpoints de analytics fornecem visibilidade completa sobre a performance de recuperação. Acompanhe o funil de cobrança, compare períodos, identifique as melhores campanhas e exporte dados para análise externa.

Endpoints

#
MétodoEndpointDescrição
GET/api/analytics/funnelFunil: pendente, contactado, negociando, pago
GET/api/analytics/comparisonComparação entre períodos
GET/api/analytics/campaignsRanking de campanhas por performance
GET/api/analytics/trendTendência diária dos últimos 30 dias
GET/api/analytics/exportExportar dados em CSV
ℹ️

Todos os endpoints requerem autenticação via JWT (Authorization: Bearer TOKEN).


Funil de recuperação

GET/api/analytics/funnel

Retorna o funil completo de cobrança com contagem e valor em cada etapa: PENDING (pendente), CONTACTED (contactado), NEGOTIATING (negociando) e PAID (pago).


Comparação entre períodos

GET/api/analytics/comparison

Compara indicadores entre dois períodos (ex: mês atual vs. mês anterior). Retorna variação percentual de recuperação, volume e tempo médio de resolução.


Ranking de campanhas

GET/api/analytics/campaigns

Lista campanhas ordenadas por taxa de recuperação, valor recuperado ou número de pagamentos confirmados.


Tendência diária

GET/api/analytics/trend

Retorna dados diários dos últimos 30 dias: valor recuperado, novas dívidas, conversas iniciadas e pagamentos por dia.


Exportar dados em CSV

GET/api/analytics/export

Gera um arquivo CSV com os dados de analytics filtrados por período e campanha. O download é iniciado automaticamente.