Logo SOAR

Usuários por Tipo

Descrição

Retorna a quantidade de usuários por tipo (role), total geral e percentual de cada tipo, para alimentar gráficos de pizza/donut. Para papéis restritos (como Master Practitioner, Practitioner, Institutional, Partner e Individual), a contagem considera apenas os usuários da rede do usuário autenticado (usuários cujo parent_id é o ID do autenticado), não incluindo o próprio usuário na contagem.

Verbo

GET

URL Base

https://api.soargi.com

Endpoint

/dashboard/users-by-type

Cabeçalhos

Parâmetro Valor
Authorization Bearer Token

Retorno

{
  "success": true,
  "total": 2310,
  "types": [
    { "role": "Individual", "count": 421, "percent": 18.2 },
    { "role": "Practitioner", "count": 338, "percent": 14.6 },
    ...
  ]
}

Sucesso - 200

{
  "success": true,
  "total": 2310,
  "types": [
    { "role": "Individual", "count": 421, "percent": 18.2 },
    { "role": "Practitioner", "count": 338, "percent": 14.6 },
    ...
  ]
}

Erro - 401 (Token Inválido)

{
    "success": false,
    "code": 401,
    "message": "Invalid token: incorrect issuer or audience"
}

Códigos de Resposta

  • 200 - Sucesso
  • 401 - Token Inválido