QuickStatus — API Documentation

GET /api/status

Returns the full service list with current status, severity, latency, and IP.

{
  "status": "success",
  "data": [
    { "name": "v1", "category": "APIs", "status": "UP",
      "severity": "GOOD", "latency": 84, "ip": "167.235.41.12" }
  ]
}

GET /api/status/live

Live tick used by the dashboard. Refreshes per-service latency and includes fleet aggregates. Poll at most once per second.

{
  "status": "success",
  "services": [ { "id": "…", "name": "v1", "status": "UP",
                  "latency": 92, "color": "#10b981" } ],
  "fleet": { "total": 28, "up": 28, "avg_latency": 84 }
}

GET /api/monitor/<service_id>

Live snapshot for a single service. Accepts a MongoDB id or the service name (case-insensitive).

{
  "status": "success",
  "latency": 92,
  "online": true,
  "service_status": "UP",
  "severity": "GOOD",
  "color": "#10b981",
  "active_incidents": 0
}

GET /api/incidents

Full incident history, newest first, including every status update.

{
  "status": "success",
  "data": [
    { "_id": "…", "title": "Network Issues", "severity": "MINOR",
      "status": "INVESTIGATING", "date": "2026-09-25T…",
      "updates": [ { "message": "…", "date": "…", "status": "INVESTIGATING" } ] }
  ]
}

GET /api/metrics

Fleet-wide aggregates: health counts, per-category stats, and the slowest services.

{
  "status": "success",
  "data": {
    "total": 28, "up": 27, "degraded": 1, "down": 0,
    "avg_latency": 96, "uptime_pct": 96.4,
    "categories": [ { "name": "APIs", "total": 21, "up": 20,
                      "uptime": 95.2, "avg_latency": 88 } ],
    "slowest": [ { "name": "v7", "latency": 412 } ]
  }
}

POST /api/subscribe

Subscribe an email address to incident notifications.

POST /api/subscribe
Content-Type: application/json

{ "email": "you@example.com" }

→ { "status": "success", "message": "Subscribed. …" }

Public API