Get cluster insights overview
const url = 'http://localhost:8000/clusters/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/insights/overview?realm=customer-portal';
const options = {
method: 'GET',
headers: {'API-Version': '2026-06-01.beta', 'API-Key': '<API-Key>'}
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}curl --request GET \
--url 'http://localhost:8000/clusters/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/insights/overview?realm=customer-portal' \
--header 'API-Key: <API-Key>' \
--header 'API-Version: 2026-06-01.beta'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
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Query Parameters
Section titled “Query Parameters”Keycloak realm name (not ID). Must start with a letter; allows letters, digits, and hyphens.
Example
customer-portalRestrict metrics to a specific realm.
Inclusive start time (ISO 8601). Defaults to 24 hours ago when omitted.
Inclusive end time (ISO 8601). Defaults to the current time when omitted.
Header Parameters
Section titled “Header Parameters”Responses
Section titled “Responses”The request has succeeded.
High-level summary of cluster activity over the requested time window.
object
Ratio of successful to total login attempts (0–1).
Mean authentication endpoint response time, in milliseconds.
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.
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.
Example generated
{
"total_users": 1,
"active_sessions": 1,
"login_success_rate": 1,
"avg_response_time": 1,
"total_login_attempts": 1,
"failed_login_attempts": 1,
"session_cache_entries": 1,
"max_session_cache_per_pod": 1
}The server could not understand the request due to invalid syntax.
RFC 9457 Problem Details object.
object
Example generated
{
"type": "https://example.com",
"title": "example",
"status": 1,
"detail": "example",
"instance": "https://example.com"
}Access is unauthorized.
RFC 9457 Problem Details object.
object
Example generated
{
"type": "https://example.com",
"title": "example",
"status": 1,
"detail": "example",
"instance": "https://example.com"
}Access is forbidden.
RFC 9457 Problem Details object.
object
Example generated
{
"type": "https://example.com",
"title": "example",
"status": 1,
"detail": "example",
"instance": "https://example.com"
}The server cannot find the requested resource.
RFC 9457 Problem Details object.
object
Example generated
{
"type": "https://example.com",
"title": "example",
"status": 1,
"detail": "example",
"instance": "https://example.com"
}Client error
object
object
Example generated
{
"type": "https://example.com",
"title": "example",
"status": 1,
"detail": "example",
"instance": "https://example.com",
"errors": [
{
"field": "example",
"detail": "example",
"code": "example",
"value": "example"
}
]
}Client error
RFC 9457 Problem Details object.
object
Example generated
{
"type": "https://example.com",
"title": "example",
"status": 1,
"detail": "example",
"instance": "https://example.com"
}Headers
Section titled “Headers”Server error
RFC 9457 Problem Details object.
object
Example generated
{
"type": "https://example.com",
"title": "example",
"status": 1,
"detail": "example",
"instance": "https://example.com"
}Server error
RFC 9457 Problem Details object.
object
Example generated
{
"type": "https://example.com",
"title": "example",
"status": 1,
"detail": "example",
"instance": "https://example.com"
}