---
title: "Get cluster insights overview"
method: GET
path: "/clusters/{cluster_id}/insights/overview"
tags: ["Cluster Insights"]
---

# Get cluster insights overview

`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`

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`

## Path parameters

- `cluster_id` string, uuid, required

## Query parameters

- `realm` string: Keycloak realm name (not ID). Must start with a letter; allows letters, digits, and hyphens.
- `start_time` string, date-time
- `end_time` string, date-time

## Headers

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

## Response `200`

The request has succeeded.

- ClusterOverview: High-level summary of cluster activity over the requested time window.
  - `total_users` integer, required
  - `active_sessions` integer, required
  - `login_success_rate` number, double, required: Ratio of successful to total login attempts (0–1).
  - `avg_response_time` number, double, required: Mean authentication endpoint response time, in milliseconds.
  - `total_login_attempts` integer, required
  - `failed_login_attempts` integer, required
  - `session_cache_entries` integer: 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_pod` integer: 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.

## Other responses

- `400`: The server could not understand the request due to invalid syntax.
- `401`: Access is unauthorized.
- `403`: Access is forbidden.
- `404`: The server cannot find the requested resource.
- `422`: Client error
- `429`: Client error
- `500`: Server error
- `501`: Server error

---

[API](https://skmtc.dev/skycloak/apis/skycloak-public-api.md) · [All operations](https://skmtc.dev/skycloak/apis/skycloak-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/skycloak/apis/skycloak-public-api/revisions/33a69e2ce35f?raw)