Docs/API Reference/Scoring
DashboardGitHub

O scoring preditivo atribui uma pontuação de 0 a 100 para cada dívida, indicando a probabilidade de pagamento. O modelo considera histórico de comportamento, dados do bureau, tempo de atraso e padrões de resposta nas conversas.

Endpoints

#
MétodoEndpointDescrição
GET/api/scoring/:debtIdScore de uma dívida (0-100)
GET/api/scoring/campaign/:campaignIdScores de toda a campanha
GET/api/scoring/distributionDistribuição: alta, média, baixa, improvável
POST/api/scoring/refresh/:campaignIdRecalcular scores da campanha
ℹ️

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


Score de uma dívida

GET/api/scoring/:debtId

Retorna o score preditivo de uma dívida específica (0-100), a faixa de classificação (HIGH, MEDIUM, LOW, UNLIKELY) e os fatores que mais influenciaram o cálculo.


Scores da campanha

GET/api/scoring/campaign/:campaignId

Retorna os scores de todas as dívidas de uma campanha, ordenados por probabilidade de pagamento. Útil para priorizar o envio de mensagens.


Distribuição de scores

GET/api/scoring/distribution

Retorna a distribuição agregada dos scores: quantas dívidas estão classificadas como alta, média, baixa probabilidade e improvável. Inclui valor total por faixa.


Recalcular scores

POST/api/scoring/refresh/:campaignId

Dispara o recálculo dos scores de todas as dívidas de uma campanha. O processo roda em background e pode levar alguns minutos dependendo do volume.

⚠️

O recálculo consome créditos de consulta ao bureau. Use com moderação.