Descrição

Este endpoint retorna os principais indicadores do dashboard, permitindo o acompanhamento da evolução mensal de cada métrica. São apresentados totais e percentuais de variação para usuários, licenças (geradas, utilizadas e adquiridas), avaliações e feedbacks (concluídos e pendentes). Para papéis restritos (como Master Practitioner, Practitioner, Institutional, Partner e Individual), os indicadores de usuários consideram apenas os usuários da sua rede (aqueles cujo parent_id é o ID do usuário autenticado), ou seja, o próprio usuário autenticado não é incluído na contagem de usuários. 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.

Cabeçalhos

Sucesso - 200

{
    "success": true,
    "data": {
        "total_users": 10,
        "users_percent_change": 5.2,
        "acquired_licenses": 8,
        "acquired_licenses_percent_change": 10.0,
        "generated_licenses": 15,
        "generated_licenses_percent_change": 20.0,
        "available_licenses": 8,
        "available_licenses_percent_change": 5.0,
        "used_licenses": 7,
        "used_licenses_percent_change": 16.7,
        "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_users: Total de usuários considerados no escopo do usuário autenticado (para papéis restritos, apenas usuários da rede, excluindo o próprio usuário autenticado).
• users_percent_change: Variação percentual de usuários em relação ao mês anterior.
• acquired_licenses: Total de licenças adquiridas (status_id = 1).
• acquired_licenses_percent_change: Variação percentual de licenças adquiridas em relação ao mês anterior.
• generated_licenses: Total de licenças geradas no sistema (todas as licenças criadas no escopo do usuário).
• generated_licenses_percent_change: Variação percentual de licenças geradas em relação ao mês anterior.
• available_licenses: Total de licenças disponíveis (geradas - utilizadas, ou seja, licenças com completed_at vazio). Mantém a relação Geradas = Disponíveis + Utilizadas.
• available_licenses_percent_change: Variação percentual de licenças disponíveis (criadas no período e ainda não utilizadas) em relação ao mês anterior.
• used_licenses: Total de licenças utilizadas (licenças com completed_at preenchido).
• used_licenses_percent_change: Variação percentual de licenças utilizadas 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 (feedback_status = 'completed').
• completed_feedbacks_percent_change: Variação percentual de feedbacks concluídos em relação ao mês anterior.
• pending_feedbacks: Total de feedbacks pendentes (feedback_status != 'completed' ou null).
• 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).