Cluster Insights

Get cluster insights overview

Returns a high-level summary of cluster activity: user counts, active sessions, login success rate, and average response time.

When neither start_time nor end_time is provided the window covers the last 24 hours.

Required scope: clusters:insights:read

get/clusters/{cluster_id}/insights/overview

Request

  • Base URL: http://localhost:8000
  • URL: http://localhost:8000/clusters/{cluster_id}/insights/overview
  • Auth: API key in header API-Key

Path parameters

cluster_idstring uuid required

Query parameters

realmstring

Keycloak realm name (not ID). Must start with a letter; allows letters, digits, and hyphens.

Example:customer-portal

Restrict metrics to a specific realm.

start_timestring date-time

Inclusive start time (ISO 8601). Defaults to 24 hours ago when omitted.

end_timestring date-time

Inclusive end time (ISO 8601). Defaults to the current time when omitted.

Headers

API-Version'2026-06-01.beta' required

Response

The request has succeeded.

total_usersinteger required
active_sessionsinteger required
login_success_ratenumber double required

Ratio of successful to total login attempts (0–1).

avg_response_timenumber double required

Mean authentication endpoint response time, in milliseconds.

total_login_attemptsinteger required
failed_login_attemptsinteger required
session_cache_entriesinteger

Total in-memory Infinispan entries across the session, clientSession, offlineSession and offlineClientSession caches, summed over all pods of the cluster. Bounded by the per-size cache max-count; the database is the source of truth.

max_session_cache_per_podinteger

Largest per-pod in-memory session-cache occupancy across the cluster's pods. Compare against the configured max-count to gauge eviction pressure / OOM risk.

Changes

No recorded changes to this operation across all 1 revision of this API.