Indicadores de Dados para Página de Avaliações

Descrição

Este endpoint retorna os principais indicadores de avaliações, permitindo o acompanhamento da evolução mensal de cada métrica. São apresentados totais e percentuais de variação para membros, licenças disponíveis, avaliações e feedbacks (concluídos e pendentes). Os dados facilitam a análise de desempenho, engajamento e utilização do sistema ao longo do tempo, respeitando o nível de acesso do usuário autenticado.

Verbo

GET

URL Base

https://api.soargi.com

Endpoint

/assessment/indicators

Cabeçalhos

Parâmetro Valor
Authorization Bearer Token

Sucesso - 200

{
    "success": true,
    "data": {
        "total_members": 10,
        "members_percent_change": 5.2,
        "available_licenses": 8,
        "available_licenses_percent_change": 10.0,
        "completed_assessments": 4,
        "completed_assessments_percent_change": 33.3,
        "pending_assessments": 2,
        "pending_assessments_percent_change": -20.0,
        "completed_feedbacks": 3,
        "completed_feedbacks_percent_change": 50.0,
        "pending_feedbacks": 1,
        "pending_feedbacks_percent_change": -50.0
    }
}

Erro - 401 (Não autenticado)

{
    "status": 401,
    "error": "Invalid or expired token."
}

Códigos de Resposta

  • 200 - Indicadores retornados com sucesso
  • 401 - Não autenticado ou token inválido

Detalhes dos Indicadores

  • total_members: Total de membros (usuários) considerados no escopo do usuário autenticado.
  • members_percent_change: Variação percentual de membros em relação ao mês anterior.
  • available_licenses: Total de licenças disponíveis.
  • available_licenses_percent_change: Variação percentual de licenças disponíveis em relação ao mês anterior.
  • completed_assessments: Total de avaliações concluídas.
  • completed_assessments_percent_change: Variação percentual de avaliações concluídas em relação ao mês anterior.
  • pending_assessments: Total de avaliações pendentes.
  • pending_assessments_percent_change: Variação percentual de avaliações pendentes em relação ao mês anterior.
  • completed_feedbacks: Total de feedbacks concluídos.
  • completed_feedbacks_percent_change: Variação percentual de feedbacks concluídos em relação ao mês anterior.
  • pending_feedbacks: Total de feedbacks pendentes.
  • pending_feedbacks_percent_change: Variação percentual de feedbacks pendentes em relação ao mês anterior.

Observações

  • É necessário estar autenticado para acessar este endpoint.
  • Os valores retornados são inteiros (totais) e decimais (percentuais) representando a evolução mensal de cada indicador.
  • Os dados respeitam as regras de visualização por perfil de usuário (role).