> ## Documentation Index
> Fetch the complete documentation index at: https://docs.use.observer/llms.txt
> Use this file to discover all available pages before exploring further.

# Status badges and the public status API

> Embed a live status badge in a README, and read page status as JSON or feeds.

Every public status page exposes three machine-readable surfaces
alongside the HTML page: an SVG badge, a JSON status document, and
Atom/RSS feeds. All of them live on the page's own domain, work
without authentication, and respect the page's access mode (a
password-protected or sign-in protected page serves a neutral
`restricted` badge and denies the JSON document).

## Badge

```
https://<subdomain>.use.observer/badge.svg
```

Embed in a README:

```markdown theme={null}
[![status](https://demo.use.observer/badge.svg)](https://demo.use.observer)
```

### Parameters

| Parameter | Values | Effect |
| - | - | - |
| `style` | `flat`, `flat-square`, `for-the-badge`, `blueprint` | Visual style. The first three match the shields.io names; `for-the-badge` renders the tall uppercase variant. The default is `blueprint` for pages on the Blueprint layout and `flat` otherwise. |
| `theme` | `light`, `dark` | `blueprint` style only. Pins the badge to light or dark; by default it follows the viewer's colour scheme. |
| `metric` | `uptime` | Show 30-day uptime percent (the share of measured time without an outage) instead of the current status. The badge color still follows the current status, so a degraded page never hides behind a green number. |
| `label` | any short text | Replace the left segment (default `status` or `uptime 30d`). |

Examples:

```markdown theme={null}
![status](https://demo.use.observer/badge.svg?style=for-the-badge)
![uptime](https://demo.use.observer/badge.svg?metric=uptime&label=api%20uptime)
```

The status badge is cached for one minute and the uptime badge for
five, with a `stale-while-revalidate` window, so README embeds stay
fast and a status flip appears within minutes.

## JSON status

```
https://<subdomain>.use.observer/status.json
```

Returns the page's current verdict, incident and maintenance
counts, and 30-day uptime. Suitable for dashboards, CLI checks,
and uptime aggregators. The shape:

```json theme={null}
{
  "page": "Observer",
  "status": "healthy",
  "status_label": "operational",
  "open_incidents": 0,
  "active_maintenance": false,
  "uptime_30d_pct": 99.98,
  "as_of": "2026-07-07T20:00:00.000Z",
  "url": "https://status.use.observer",
  "slos": [
    {
      "name": "API uptime",
      "service": "Platform",
      "target_pct": 99.9,
      "window_days": 30,
      "budget_remaining_pct": 87.4
    }
  ]
}
```

`status` is one of `healthy`, `degraded`, `unhealthy`,
`maintenance`, or `no_data`. `status_label` is the matching word
shown on the badge: `operational`, `degraded`, `outage`,
`maintenance`, or `unknown`.

The `slos` array carries the page's public SLOs (the same set the page
renders): name, owning service, target, window, and remaining error
budget. It is empty when no SLO on the page is marked public or the
plan does not include public SLO visibility. A budget of `null` means
the SLO is still collecting its first day of observation.

## Feeds

```
https://<subdomain>.use.observer/feed.atom
https://<subdomain>.use.observer/feed.rss
```

Incident and maintenance history as a standard feed. Most chat
tools and feed readers can subscribe directly. Each entry links to the
update's permalink, `/incidents/<id>`.

## Maintenance calendar

```
https://<subdomain>.use.observer/calendar.ics
```

Scheduled maintenance as an iCalendar feed that Google Calendar, Apple
Calendar, and Outlook can subscribe to. See
[Upcoming maintenance and the calendar feed](https://docs.use.observer/docs/guides/maintenance-calendar.md).

## Custom domains

All of these surfaces work unchanged on a page's custom domain once it
is active: `https://status.yourdomain.com/badge.svg` and so on.

> [!NOTE]
>
> **Badge on the page you are reading**
>
> Observer's own status page serves the same badge:
>
> `https://status.use.observer/badge.svg`


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.