Nunciatura Provista

API Documentation V1

Dashboard Processes by Status

Retorna a contagem de processos agrupados por status

Este endpoint é do tipo: Protected

Descrição

Retorna a quantidade de processos agrupados por status (A iniciar, Em andamento, Concluído). Ideal para criar gráficos de pizza ou donut chart mostrando a distribuição dos processos.

  • Valida o token JWT no header Authorization
  • Agrupa processos por status atual
  • Retorna contagem e cores sugeridas para cada status
  • Ideal para visualização em gráficos de pizza
  • Recomendação de tipo de gráfico incluída na resposta

Detalhes do Endpoint

VERBO

GET

URL BASE

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

ENDPOINT

/dashboard/processes-by-status

Cabeçalhos

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

Respostas

Sucesso - 200

{
    "success": true,
    "data": [
        {
            "status": "A iniciar",
            "count": 5,
            "color": "#6B7280"
        },
        {
            "status": "Em andamento",
            "count": 12,
            "color": "#F59E0B"
        },
        {
            "status": "Concluído",
            "count": 8,
            "color": "#10B981"
        }
    ],
    "chart_type": "pie",
    "chart_recommendation": "Use um gráfico de Pizza (Pie Chart) ou Donut Chart para melhor visualização da distribuição"
}

Erro - 401 (Não autorizado)

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

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

Campos da Resposta

Campo Tipo Descrição
status string Nome do status (A iniciar, Em andamento, Concluído)
count integer Quantidade de processos neste status
color string Cor sugerida em hexadecimal para o gráfico
chart_type string Tipo de gráfico recomendado (pie)
chart_recommendation string Recomendação detalhada do tipo de visualização

Códigos de Resposta

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