KPIs e Dashboard

Endpoints para dashboard e analytics financeiro. Metricas de receita, despesas, clientes, contratos e LTV.

GET/api/kpis

Retorna os KPIs principais do dashboard.

curl -s "https://flow.seudominio.com/api/kpis" \
  -H "Authorization: Bearer $TOKEN" | jq .

200KPIs do dashboard

json

{
  "success": true,
  "data": {
    "totalRevenue": 175000.00,
    "totalExpenses": 62000.00,
    "balance": 113000.00,
    "profit": 113000.00,
    "totalClients": 45,
    "activeClients": 38,
    "pendingInvoices": 8
  }
}

GET/api/kpis/chart

Dados para grafico de receita vs despesas ao longo do tempo.

Parametros

Nome	Tipo	Obrigatorio	Descricao
`months`(query)	`integer`	Nao	Numero de meses(default: `6`)

200Dados do grafico

json

{
  "success": true,
  "data": [
    { "month": "2025-09", "revenue": 28000, "expense": 12000 },
    { "month": "2025-10", "revenue": 31000, "expense": 11500 },
    { "month": "2025-11", "revenue": 29500, "expense": 10000 },
    { "month": "2025-12", "revenue": 35000, "expense": 13000 },
    { "month": "2026-01", "revenue": 32000, "expense": 9500 },
    { "month": "2026-02", "revenue": 19500, "expense": 6000 }
  ]
}

GET/api/kpis/summary

Resumo completo consolidado de todas as analytics.

bash

curl -s "https://flow.seudominio.com/api/kpis/summary" \
  -H "Authorization: Bearer $TOKEN" | jq .

GET/api/kpis/top-clients

Top clientes por receita gerada.

Parametros

Nome	Tipo	Obrigatorio	Descricao
`limit`(query)	`integer`	Nao	Quantidade de clientes(default: `10`)

200Top clientes

json

{
  "success": true,
  "data": [
    { "clientId": "clx1", "name": "Empresa ABC", "revenue": 45000.00 },
    { "clientId": "clx2", "name": "Tech Corp", "revenue": 38000.00 },
    { "clientId": "clx3", "name": "Startup XYZ", "revenue": 22000.00 }
  ]
}

GET/api/kpis/contracts

Analytics de contratos: ativos, cancelados, receita recorrente.

GET/api/kpis/ltv

Metricas de Lifetime Value (LTV) dos clientes.

Historico

GET/api/kpis/history

Historico de KPIs ao longo do tempo.

Parametros

Nome	Tipo	Obrigatorio	Descricao
`days`(query)	`integer`	Nao	Numero de dias(default: `30`)

POST/api/kpis/snapshot

Salva um snapshot dos KPIs atuais para historico.

GET/api/kpis/new-clients

Analytics de novos clientes.

Parametros

Nome	Tipo	Obrigatorio	Descricao
`days`(query)	`integer`	Nao	Periodo em dias(default: `30`)