Dashboard

Métricas

Referência

Endpoints de analytics para integrar dashboards e relatórios: resumos e séries de assinaturas e cobranças, sem montar agregações a partir da listagem transacional.

Contrato de integração. Use Bearer do POST /auth/token.
Disponível apenas em produção. As rotas de métricas não existem no sandbox. Use credenciais de produção e a URL https://api.validapay.com.br.

Quando utilizar

  • Dashboard externo com MRR, churn e inadimplência da carteira
  • Relatórios diários ou mensais sem listar cobranças uma a uma
  • Separar volume emitido vs pago com dateBasis em cobranças
  • Correlacionar queda de MRR ACTIVE com churn ou inadimplência

Autenticação

Credenciais de assinatura ou de cobrança já existentes costumam bastar.

RotasScopes
Assinaturas (summary + séries)subscriptions/read
Cobranças (summary)charges/read / pix.cob/read

Rotas

OperaçãoDescrição
Assinaturas
GET /v1/analytics/subscriptions/summary
Cards: MRR, ARR, churn, delinquentMrr, previousPeriod/growth e breakdowns.
Cobranças
GET /v1/analytics/charges/summary
Totais e breakdowns por período; dateBasis created, paid ou created_and_paid.
MRR
GET /v1/analytics/mrr
Série temporal de estoque ACTIVE (mensal ou diário) e assinantes.
MRRM
GET /v1/analytics/mrr/by-payment-method/series
Mesmo recorte do MRR, fatiado por paymentType para gráfico empilhado.
Inadimplência
GET /v1/analytics/mrr/delinquency
Estoque DEFAULT + PAST_DUE e inflow diário, distinto de churn.
Churn
GET /v1/analytics/churn
Perda de MRR por assinaturas CANCELED/EXPIRED que já pagaram ao menos um ciclo.

Regras importantes

  • •Valores monetários em reais, string decimal (ex.: "12345.67").
  • •Em summaries, startDate e endDate devem vir juntos; apenas um → 400 INVALID_DATE_RANGE.
  • •/mrr é estoque ACTIVE; /churn é evento de perda; /mrr/delinquency é estoque overdue.
  • •Em /charges/summary, paidNetAmount exige status PAID; dateBasis inválido → 400 INVALID_DATE_BASIS.
Essa página foi útil?