Nunciatura Provista

API Documentation V1

Dashboard Statistics

Retorna estatísticas gerais para o dashboard administrativo

Este endpoint é do tipo: Protected

Descrição

Retorna estatísticas consolidadas para o dashboard administrativo com as seguintes funcionalidades:

  • Valida o token JWT no header Authorization
  • Calcula estatísticas em tempo real do sistema
  • Retorna contadores de usuários, processos, grupos e circunscrições
  • Inclui métricas de progresso dos processos de provisão
  • Fornece dados para visualização em cards do dashboard
  • Atualização automática a cada requisição

Detalhes do Endpoint

VERBO

GET

URL BASE

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

ENDPOINT

/dashboard/statistics

Cabeçalhos

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

Respostas

Sucesso - 200

{
    "success": true,
    "data": {
        "administradores_banco_dados": 2,
        "informadores_banco_dados": 37,
        "total_usuarios": 39,
        "usuarios_ativos": 27,
        "usuarios_blacklist": 12,
        "circunscricoes_eclesiasticas": 20,
        "total_grupos": 6,
        "provisoes_a_iniciar": 3,
        "provisoes_em_andamento": 4,
        "provisoes_concluidas": 4,
        "total_processos": 11
    }
}

Erro - 401 (Não autorizado)

{
    "success": false,
    "message": "Token não fornecido"
}

Condição: Token JWT não fornecido, inválido ou expirado

Erro - 500 (Erro interno)

{
    "success": false,
    "message": "Erro interno do servidor"
}

Condição: Erro inesperado ao processar a requisição

Campos da Resposta

Campo Tipo Descrição
administradores_banco_dados integer Total de administradores cadastrados no sistema
informadores_banco_dados integer Total de informadores cadastrados no sistema
total_usuarios integer Total de usuários cadastrados no sistema
usuarios_ativos integer Total de usuários ativos (não blacklistados)
usuarios_blacklist integer Total de usuários na blacklist
circunscricoes_eclesiasticas integer Total de circunscrições eclesiásticas (fixo: 20)
total_grupos integer Total de grupos eclesiásticos cadastrados
provisoes_a_iniciar integer Total de processos de provisão a iniciar
provisoes_em_andamento integer Total de processos de provisão em andamento
provisoes_concluidas integer Total de processos de provisão concluídos
total_processos integer Total de processos de provisão cadastrados

Códigos de Resposta

Código Descrição
200 Estatísticas retornadas com sucesso
401 Token não fornecido, inválido ou expirado
500 Erro interno do servidor