Indicadores de Dados

Descrição

Retorna alguns indicadores de usuários, como total de usuários, licenças adquiridas, licenças não usadas, avaliações completas, avaliações pendentes, feedbacks completos e feedbacks pendentes.

Verbo

GET

URL Base

https://api.soargi.com

Endpoint

/users/indicators

Cabeçalhos

Parâmetro Valor
Authorization Bearer Token

Sucesso - 200

{
    "success": true,
    "data": {
        "total_users": 3,
        "users_percent_change": -100,
        "acquired_licenses": 0,
        "acquired_licenses_percent_change": 0,
        "unused_licenses": 0,
        "unused_licenses_percent_change": 0,
        "completed_assessments": 1,
        "completed_assessments_percent_change": -100,
        "pending_assessments": 0,
        "pending_assessments_percent_change": 0,
        "completed_feedbacks": 0,
        "completed_feedbacks_percent_change": 0,
        "pending_feedbacks": 1,
        "pending_feedbacks_percent_change": -100
    }
}

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

Observações

  • É necessário estar autenticado para acessar este endpoint.
  • Os valores retornados são inteiros e representam a contagem atual de cada indicador.