Skip to content
bynhDocs
Log in

Get the status overview

GET/workspaces/{workspace}/status

Returns your status page’s overall state, headline numbers for the last 90 days, the next maintenance window and every monitor with its daily bars.

Authentication

Send an API token as a bearer token. This endpoint needs a read token, made by any member of the workspace. Create one in My account → API tokens; see scopes and roles.

Authorization: Bearer 42|bynh_pat_•••••••Header

Path parameters

  • workspacestringRequired

    Your workspace slug, e.g. dokan.

Response

200 OK

Overview.

  • page_urlstring{frontend_url}/trust/{slug}/status.
  • overallenumWorst state across components. One of operational, maintenance, degraded, partial_outage, major_outage.
  • overall_labelstringLocalized (major_outage reads “Down”).
  • checks_every_secondsinteger|nullShortest interval among active monitors.
  • statsobjectuptime_90d (average across active monitors, 3 decimals, or null), response_median_ms (last 24h), incidents_90d, last_incident {id, title, duration_minutes, started_at, resolved}|null, next_maintenance (Maintenance)|null, open_incidents.
  • monitors[]MonitorRowSorted by name.

Rate limits

This endpoint counts toward your general limit of 120 requests a minute. When you go over, wait for the number of seconds in Retry-After.

Errors

401The token is missing, wrong, revoked or expired.
404The token belongs to another workspace, or its owner is no longer a member.

Every error is JSON with a message. See Errors.

Next →List monitors
curl "https://api.bynh.io/api/v1/workspaces/dokan/status" \
  -H "Authorization: Bearer $BYNH_TOKEN" \
  -H "Accept: application/json"

Response200 OK

application/json
{
  "data": {
    "page_url": "https://bynh.io/trust/dokan/status",
    "overall": "operational",
    "overall_label": "Operational",
    "checks_every_seconds": 60,
    "stats": {
      "uptime_90d": 99.968,
      "response_median_ms": 176,
      "incidents_90d": 2,
      "last_incident": {
        "id": 18,
        "title": "Checkout is slow",
        "duration_minutes": 42,
        "started_at": "2026-09-14T18:03:00+00:00",
        "resolved": true
      },
      "next_maintenance": null,
      "open_incidents": 0
    },
    "monitors": [
      {
        "id": 4,
        "name": "Checkout API",
        "type": "http",
        "type_label": "HTTPS",
        "target": "api.dokan.sa/health",
        "status": "up",
        "status_label": "Up",
        "status_changed_at": "2026-09-28T02:14:00+00:00",
        "uptime_90d": 99.982,
        "response_ms": 182,
        "slow_after_ms": 1500,
        "interval_seconds": 60,
        "last_checked_at": "2026-10-01T07:59:01+00:00",
        "last_error": null,
        "tags": [
          "payments"
        ],
        "component": {
          "id": 2,
          "name": "Checkout",
          "group_id": 1
        },
        "bars": [
          {
            "day": "2026-07-04",
            "uptime": 100,
            "incident_minutes": 0
          },
          {
            "day": "2026-10-01",
            "uptime": 99.931,
            "incident_minutes": 1
          }
        ]
      }
    ]
  }
}

Examples use Dokan, a sample workspace. Responses are shortened where lists are long.