Obter KPIs do Dashboard

Retorna métricas agregadas da matriz e filiais. Requer scope dashboard:read.

Autenticação:

🔑 API Key

Parâmetros de Consulta

empresa_idnumber

Filtrar KPIs por empresa específica (opcional)

Respostas

{
  "ok": true,
  "data": {
    "colaboradores": {
      "ativos": 45,
      "total": 50
    },
    "registros": {
      "hoje": 120,
      "total": 15420
    },
    "departamentos": {
      "total": 8
    },
    "dispositivos": {
      "ativos": 35,
      "total": 40
    },
    "arquivos": {
      "ultimos30Dias": 12
    }
  }
}

Sandbox Mode

curl --request GET \
  'http://localhost:3000/api/v1/dashboard/kpis?empresa_id=1' \
  --header 'x-api-key: yk_sua_api_key'

Exemplos de Resposta

{
  "ok": true,
  "data": {
    "colaboradores": {
      "ativos": 45,
      "total": 50
    },
    "registros": {
      "hoje": 120,
      "total": 15420
    },
    "departamentos": {
      "total": 8
    },
    "dispositivos": {
      "ativos": 35,
      "total": 40
    },
    "arquivos": {
      "ultimos30Dias": 12
    }
  }
}