Group Stats and Health

Uptime, response time and health summaries for groups

Overview

Two read-only endpoints summarise how the monitors in your groups are performing.

Both endpoints are for session (JWT) authentication only. Requests made with an API key are rejected.

Group stats

GET /api/groups/{groupId}/stats

Header: Authorization: Bearer YOUR_JWT

curl https://api.uptimeio.com/api/groups/550e8400-e29b-41d4-a716-446655440000/stats \
  -H "Authorization: Bearer YOUR_JWT"

{
  "success": true,
  "data": {
    "total_monitors": 5,
    "active_monitors": 4,
    "paused_monitors": 1,
    "monitors_up": 4,
    "monitors_down": 0,
    "avg_response_time": 182.4,
    "uptime_percentage": 99.98,
    "historical": {
      "last_24h": { "uptime": 99.98, "avg_response_time": 182.4 },
      "last_7d": { "uptime": 99.91, "avg_response_time": 190.7 },
      "last_30d": { "uptime": 99.87, "avg_response_time": 195.3 }
    }
  }
}

Field	Type	Description
total_monitors / active_monitors / paused_monitors	number	Monitor counts in the group.
monitors_up / monitors_down	number	Monitors whose latest result succeeded / failed.
avg_response_time	number	Average response time in ms over the last hour.
uptime_percentage	number	Uptime over the last 24 hours, weighting every monitor equally.
historical	object	Uptime (time-weighted, every monitor weighted equally) and average response time for the last 24 hours (last_24h), 7 days (last_7d) and 30 days (last_30d).

Errors: 404 RESOURCE_NOT_FOUND (Group not found), 401 for missing credentials, 500 INTERNAL_ERROR (Failed to get group stats).

Groups health summary

GET /api/groups/health-summary

Returns one entry per group in your project (default project, or the one named in X-Project-ID), ordered by name. uptime_percentage is the 24-hour uptime rounded to a whole number.

curl https://api.uptimeio.com/api/groups/health-summary \
  -H "Authorization: Bearer YOUR_JWT"

{
  "success": true,
  "data": {
    "groups": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "name": "Web Services",
        "check_count": 5,
        "health_status": "healthy",
        "uptime_percentage": 100
      }
    ]
  }
}

health_status	Meaning
healthy	No monitor in the group is currently failing.
degraded	Some, but not all, monitors are failing.
down	Every monitor in the group is failing.
unknown	The group has no monitors.

Errors: 401 for missing credentials, 500 INTERNAL_ERROR (Failed to get groups health summary).