# CheckBeacon

> CheckBeacon is uptime, latency, and user-journey monitoring for your **APIs and web apps**. It runs HTTP checks against your endpoints and real-browser (Playwright) journeys against your UI — from multiple regions, on a schedule — and alerts you when something breaks. It is API-first and self-hostable (Docker + Helm; SQLite or MySQL).

## What CheckBeacon monitors

- **API / HTTP checks:** any endpoint and method (GET/POST/PUT/PATCH/DELETE) with custom headers, request body, and authentication (none, Basic, Bearer token, or API-key header). Validates expected status codes, a response-time threshold, response MIME type, and body assertions (JSON-field or text checks: exists, equals, contains, numeric comparisons).
- **UI / browser checks:** real browser automation (Playwright) for multi-step user journeys — e.g. load a page, log in, click, and assert content — so you monitor the actual experience users see, not just the API behind it.
- **Multi-step checks:** chain requests and pass data between steps with templates like `{{step.1.body.token}}` (e.g. log in, capture a token, call an authenticated endpoint).

## Key features

- Multi-region checks, configurable per-check interval (1–60 min).
- Smart alerting: alert only after N consecutive failures to avoid flapping. Statuses: healthy, warning, unhealthy, error.
- Results history and charts (response-time and status) with time-range filtering and auto-bucketed aggregation.
- Groups, teams, and role-based access (admin / read-only).
- API-first: everything in the UI is available over a REST API (Bearer-token auth).
- Self-hostable via Docker image and Helm chart; runs on SQLite or MySQL.

## Pages

- [Home](https://checkbeacon.com/index.html): Product overview and how CheckBeacon monitors both APIs and UIs.
- [Features](https://checkbeacon.com/features.html): Detailed capabilities (API checks, UI checks, multi-step, regions, alerting, dashboards).
- [Pricing](https://checkbeacon.com/pricing.html): Free, Team ($49/mo), and Enterprise (custom) plans; also self-hostable.
- [Getting Started](https://checkbeacon.com/getting-started.html): Step-by-step setup of your first API and UI checks.
- [Developers / API Docs](https://checkbeacon.com/developers.html): REST API reference — authentication, checks, results, groups, stats, errors.
- [FAQ](https://checkbeacon.com/faq.html): Common questions about monitoring scope, alerting, regions, retention, self-hosting.
- [Security](https://checkbeacon.com/security.html): Data protection practices (encryption, access control, retention).
- [Status](https://checkbeacon.com/status.html): System status overview.
- [About](https://checkbeacon.com/about.html): Company and mission.
- [Book a demo](https://checkbeacon.com/book-demo.html): Request a personalized walkthrough.
- [Contact](https://checkbeacon.com/contact.html): sales@checkbeacon.com, support@checkbeacon.com, hello@checkbeacon.com.

## API summary

- Base URL: `https://api.checkbeacon.com/api/v1`
- Auth: `POST /auth/login` with `{ "email", "password" }` returns `{ "token", "expires_at", "user" }`; send `Authorization: Bearer <token>` on all other requests (sessions last 8 hours).
- Checks: `GET/POST /checks`, `GET/PUT/PATCH/DELETE /checks/{id}`, `POST /checks/{id}/run`.
- Results: `GET /checks/{id}/results` (filters: limit, offset, status, from, to), `/results/latest`, `/results/summary` (time-bucketed), `/results/{result_id}`.
- Groups: `GET/POST /groups`, `GET/PUT/DELETE /groups/{id}`. Misc: `GET /stats`, `GET /health`.