Nunciatura Provista

API Documentation V1

Dashboard Processes Progress

Retorna os processos com maior progresso de conclusão

Este endpoint é do tipo: Protected

Descrição

Retorna os top N processos ordenados por progresso de coleta de usuários. Ideal para gráficos de barras horizontais mostrando o percentual de conclusão.

  • Valida o token JWT no header Authorization
  • Retorna processos ordenados por users_collected
  • Calcula percentual de progresso automaticamente
  • Suporta filtro de quantidade (limit)
  • Ideal para gráfico de barras horizontais

Detalhes do Endpoint

VERBO

GET

URL BASE

http://api.provista.hmg.nabrasil.org.br/v1

ENDPOINT

/dashboard/processes-progress?limit=10

Cabeçalhos

Parâmetro Valor
Authorization Bearer {token}
Accept application/json

Parâmetros de Query

Parâmetro Tipo Obrigatório Descrição
limit integer Não Quantidade de processos (padrão: 10)

Respostas

Sucesso - 200

{
    "success": true,
    "data": [
        {
            "id": "uuid-1",
            "name": "Diocese de São Paulo",
            "protocol": "PROV-2024-001",
            "users": 20,
            "users_collected": 18,
            "progress_percentage": 90.0,
            "status": "Em andamento"
        }
    ],
    "chart_type": "bar",
    "chart_recommendation": "Use um gráfico de Barras Horizontais para mostrar o progresso de cada processo",
    "filters_applied": {
        "limit": 10
    }
}

Códigos de Resposta

Código Descrição
200 Dados retornados com sucesso
401 Token não fornecido, inválido ou expirado