---
title: "Sites in the Woods API"
description: "Every route, parameter and field of the JSON API, its errors and limits, and the MCP server."
canonical: "https://sitesinthewoods.com/api/docs"
---
# API

Monitoring data for your team's sites (status, uptime, incidents, daily insights and domains) and the writes a team makes. HTML version: https://sitesinthewoods.com/api/docs. OpenAPI: https://sitesinthewoods.com/openapi.json.

## Authentication

Authorization: Bearer sm_…, a key from the dashboard's API keys page (team sign-in cookies work too, for reads). Viewer keys read; Member and Admin keys, on teams with 10 sites or more, also write. More: https://sitesinthewoods.com/auth.md.

## Conventions

- A success is `{"data": …}`. Lists add `limit`, `offset` and `has_more`; `limit` is clamped to 1–100.
- An error is RFC 9457 problem details (`application/problem+json`): `{"type", "title", "status", "detail", "error": "code", "message": "…", "suggestion"?: "…"}`. Branch on `error`; show `message` (the same as `detail`).
- Successes and every error carry `next_steps`: `[{"method", "path", "why", "tool"?}]`; `tool` names the MCP tool that makes the call.
- Times are ISO 8601 in UTC. Durations are milliseconds, sizes bytes. Sites are named by their slug.
- Requests a minute per key, by the team's sites: 60 on the free site, 300 from 2 sites, 1,000 from 25; then 429 with `Retry-After`; writes are also capped at 10 in 10 seconds per key. Every keyed answer carries `RateLimit-Policy` and `RateLimit` (IETF draft 11): `"reads";r=57;t=23` means 57 left, the window ends in 23 seconds. The data changes once a minute, so poll at most once a minute.
- The API is unversioned and changes only by adding routes and fields; one that has to go is announced at least 90 days ahead, on its responses, with Deprecation (RFC 9745) and Sunset (RFC 8594) headers and a Link to /developers#versioning (rel="deprecation").
- Writes are idempotent: repeating one changes nothing more, so retrying after a timeout is safe.

## Errors

- `unauthorized` (401): No key, or an unknown or revoked one.
- `forbidden` (403): A write by a key whose role or team can't make it (writes need a Member or Admin key and 10 sites), a POST to a route that only reads, a write without a key, or a form post from another site.
- `not_found` (404): An unknown site slug or API path.
- `method_not_allowed` (405): Anything but GET or HEAD on a page.
- `conflict` (409): A write this incident can't take (one that can't be checked again, say).
- `validation_error` (400): A parameter isn't valid; `issues` says which.
- `request_too_large` (413): A request body over 64 KB.
- `rate_limited` (429): More requests this minute than the key's team's sites allow (comes with Retry-After): 60 on the free site, 300 from 2 sites, 1,000 from 25.
- `auth_unavailable` (503): The key or sign-in couldn't be checked right now (comes with Retry-After). Your key or session is probably fine: retry.

## MCP

https://sitesinthewoods.com/mcp is a hosted MCP server (Streamable HTTP; protocol 2026-07-28 and the 2025 revisions) with one tool per API route, named by the route's operation id, returning the route's own JSON: reads for every key, and the writes (dismiss, check again, maintenance windows, pause) for Member and Admin keys on teams with 10 sites or more. Send the same key as the API: `Authorization: Bearer sm_…`, kept in the `SITES_IN_THE_WOODS_API_KEY` environment variable rather than typed into a command. Listing the tools needs no key; without one, a call returns an error result saying how to get one. Its card: https://sitesinthewoods.com/mcp/server-card. Docs: https://sitesinthewoods.com/api/docs#mcp.

Claude Code:

```
claude mcp add --transport http sites-in-the-woods https://sitesinthewoods.com/mcp --header "Authorization: Bearer $SITES_IN_THE_WOODS_API_KEY"
```

Cursor (~/.cursor/mcp.json):

```
{
  "mcpServers": {
    "sites-in-the-woods": {
      "url": "https://sitesinthewoods.com/mcp",
      "headers": {
        "Authorization": "Bearer ${env:SITES_IN_THE_WOODS_API_KEY}"
      }
    }
  }
}
```

VS Code (.vscode/mcp.json):

```
{
  "inputs": [
    {
      "type": "promptString",
      "id": "sites-in-the-woods-key",
      "description": "Sites in the Woods API key",
      "password": true
    }
  ],
  "servers": {
    "sites-in-the-woods": {
      "type": "http",
      "url": "https://sitesinthewoods.com/mcp",
      "headers": {
        "Authorization": "Bearer ${input:sites-in-the-woods-key}"
      }
    }
  }
}
```

Tools:

- `status`: wraps `GET /api/status`. Every one of the team's sites: its status right now, and the open incidents.
- `sites`: wraps `GET /api/sites`. The team's sites: status, homepage uptime over 1, 7 and 30 days, open incidents.
- `sites_by_slug`: wraps `GET /api/sites/{slug}`. One site: its last 7 days (as in the weekly brief), open incidents, domain and TLS expiry.
- `sites_by_slug_insights`: wraps `GET /api/sites/{slug}/insights`. One site's daily insights: page weight, security headers, prefetches, page errors, broken links, cache, dead ends.
- `sites_by_slug_scans`: wraps `GET /api/sites/{slug}/scans`. One site's API recovery scans, newest first: state, how each ended, and findings by weight.
- `sites_by_slug_scans_by_id`: wraps `GET /api/sites/{slug}/scans/{id}`. One API recovery scan: what it saw, its findings, the fixes and what changed since the last scan.
- `sites_by_slug_maintenance`: wraps `GET /api/sites/{slug}/maintenance`. One site's maintenance windows: on now, scheduled, and the last 30 days.
- `sites_by_slug_map`: wraps `GET /api/sites/{slug}/map`. One site's structure from its sitemaps: sections, new and removed pages, what fails.
- `sites_by_slug_events`: wraps `GET /api/sites/{slug}/events`. What changed on one site: incidents opened and resolved, code pushes, maintenance, new pages.
- `incidents`: wraps `GET /api/incidents`. Incidents, open now or recent; open outages and slowdowns carry the likely cause.
- `domains`: wraps `GET /api/domains`. The team's domains: registration expiry, registrar, nameservers, status.
- `incidents_by_id_dismiss`: wraps `POST /api/incidents/{id}/dismiss`. Dismiss an open incident as noise.
- `incidents_by_id_undismiss`: wraps `POST /api/incidents/{id}/undismiss`. Bring back a dismissed incident.
- `incidents_by_id_recheck`: wraps `POST /api/incidents/{id}/recheck`. Check an incident again now.
- `sites_by_slug_maintenance_start`: wraps `POST /api/sites/{slug}/maintenance/start`. Start a maintenance window on a site now.
- `sites_by_slug_maintenance_end`: wraps `POST /api/sites/{slug}/maintenance/end`. End a site's maintenance windows now.
- `sites_by_slug_pause`: wraps `POST /api/sites/{slug}/pause`. Pause a site's checks.
- `sites_by_slug_resume`: wraps `POST /api/sites/{slug}/resume`. Resume a paused site's checks.

## Routes

### GET /api/status

Every one of the team's sites: its status right now, and the open incidents. Call this first, or on a schedule (at most once a minute, as often as the checks run), to see whether anything is down or warning right now.

```
curl -H "Authorization: Bearer sm_…" https://sitesinthewoods.com/api/status
```

Response fields:
- `data` (object)
- `data.sites` (object[])
- `data.sites[].slug` (string)
- `data.sites[].name` (string)
- `data.sites[].status` (string)
- `data.sites[].paused` (boolean)
- `data.openIncidents` (object[])
- `data.openIncidents[].kind` (string)
- `data.openIncidents[].severity` ("down" | "warning")
- `data.openIncidents[].site` (string or null)
- `data.openIncidents[].startedAt` (string): ISO 8601, UTC (…Z)
- `data.openIncidents[].cause` (string or null)
- `data.openIncidents[].dismissed` (boolean)
- `next_steps` (object[] (optional)): calls that usually come next ({method, path, why, tool})
- `next_steps[].method` (string (optional))
- `next_steps[].path` (string (optional))
- `next_steps[].why` (string (optional))
- `next_steps[].tool` (string (optional)): the MCP tool that makes this call, for data routes

Next steps:
- `GET /api/sites/{slug}`: one site's last 7 days, incidents, domain and TLS
- `GET /api/incidents`: what's open or recent, with likely causes

### GET /api/sites

The team's sites: status, homepage uptime over 1, 7 and 30 days, open incidents. Call this to compare sites or report on uptime over the last day, week or month. It also lists the slugs every other route takes.

```
curl -H "Authorization: Bearer sm_…" https://sitesinthewoods.com/api/sites
```

Response fields:
- `data` (object[])
- `data[].slug` (string)
- `data[].name` (string)
- `data[].project` (string)
- `data[].url` (string)
- `data[].status` (string)
- `data[].paused` (boolean)
- `data[].public` (boolean)
- `data[].checkFrom` ("us-west" | "us-east" | "split"): where the homepage, nav and newest-content checks run; a failure is checked again from the other location before it alerts or counts against uptime
- `data[].uptime` (object or null): the homepage's checks over the last 1, 7 and 30 days
- `data[].uptime.d1` (object)
- `data[].uptime.d1.ok` (integer)
- `data[].uptime.d1.total` (integer)
- `data[].uptime.d1.percent` (number or null): ok / total × 100, two decimals; null with no checks
- `data[].uptime.d7` (object)
- `data[].uptime.d7.ok` (integer)
- `data[].uptime.d7.total` (integer)
- `data[].uptime.d7.percent` (number or null): ok / total × 100, two decimals; null with no checks
- `data[].uptime.d30` (object)
- `data[].uptime.d30.ok` (integer)
- `data[].uptime.d30.total` (integer)
- `data[].uptime.d30.percent` (number or null): ok / total × 100, two decimals; null with no checks
- `data[].openIncidents` (integer)
- `data[].dismissed` (integer): of those, how many the team dismissed
- `next_steps` (object[] (optional)): calls that usually come next ({method, path, why, tool})
- `next_steps[].method` (string (optional))
- `next_steps[].path` (string (optional))
- `next_steps[].why` (string (optional))
- `next_steps[].tool` (string (optional)): the MCP tool that makes this call, for data routes

Next steps:
- `GET /api/sites/{slug}`: one site in detail
- `GET /api/sites/{slug}/insights`: one site's daily page weight, headers and broken links

### GET /api/sites/:slug

One site: its last 7 days (as in the weekly brief), open incidents, domain and TLS expiry. Call this to answer questions about one site: how it did this week, what's wrong with it now, and when its domain or certificate runs out.

```
curl -H "Authorization: Bearer sm_…" https://sitesinthewoods.com/api/sites/SITE-SLUG
```

Parameters:
- `slug` (path, string): site slug, as in /api/sites

Response fields:
- `data` (object)
- `data.slug` (string)
- `data.name` (string)
- `data.project` (string)
- `data.url` (string)
- `data.status` (string)
- `data.paused` (boolean)
- `data.public` (boolean)
- `data.checkFrom` ("us-west" | "us-east" | "split"): where the homepage, nav and newest-content checks run; a failure is checked again from the other location before it alerts or counts against uptime
- `data.week` (object or null): the last 7 days, as in the weekly brief; null for paused sites
- `data.week.from` (string): ISO 8601, UTC (…Z)
- `data.week.to` (string): ISO 8601, UTC (…Z)
- `data.week.uptime` (object)
- `data.week.uptime.ok` (integer)
- `data.week.uptime.total` (integer)
- `data.week.uptime.percent` (number or null): ok / total × 100, two decimals; null with no checks
- `data.week.typicalMs` (number or null): median homepage response time (time to first byte); for a site checked from both locations, of their average, each location counted once
- `data.week.outages` (integer)
- `data.week.longestOutageMs` (number or null)
- `data.week.warnings` (integer)
- `data.week.dismissed` (integer)
- `data.week.readers` (object or null): real readers on phones (Chrome UX Report, 28 days); null when Chrome has too little data. Times in ms
- `data.week.readers.periodEnd` (string)
- `data.week.readers.lcpP75` (number or null)
- `data.week.readers.inpP75` (number or null)
- `data.week.readers.clsP75` (number or null)
- `data.week.readers.ttfbP75` (number or null)
- `data.week.htmlBytes` (object)
- `data.week.htmlBytes.now` (number or null)
- `data.week.htmlBytes.weekAgo` (number or null)
- `data.week.brokenLinkPages` (integer)
- `data.week.pageErrors` (boolean): new errors from the site's own code right now
- `data.week.traffic` (object or null)
- `data.week.traffic.visits` (number)
- `data.week.traffic.weekBefore` (number or null)
- `data.week.traffic.pages` (number)
- `data.week.traffic.cacheHits` (number)
- `data.openIncidents` (object[])
- `data.openIncidents[].id` (string)
- `data.openIncidents[].kind` (string)
- `data.openIncidents[].label` (string)
- `data.openIncidents[].severity` ("down" | "warning")
- `data.openIncidents[].site` (string or null): site slug
- `data.openIncidents[].url` (string or null): the page or file it's about
- `data.openIncidents[].domain` (string or null)
- `data.openIncidents[].startedAt` (string): ISO 8601, UTC (…Z)
- `data.openIncidents[].resolvedAt` (string or null): ISO 8601, UTC (…Z)
- `data.openIncidents[].cause` (string or null)
- `data.openIncidents[].details` (object)
- `data.openIncidents[].dismissed` (object or null): the team marked it as noise: still open, never alerts again
- `data.openIncidents[].dismissed.by` (string)
- `data.openIncidents[].dismissed.at` (string): ISO 8601, UTC (…Z)
- `data.openIncidents[].likelyCause` (object or null (optional)): open outages and slowdowns only: the monitor's rules, as in the alert
- `data.openIncidents[].likelyCause.likely` (string or null)
- `data.openIncidents[].likelyCause.clues` (string[])
- `data.domain` (object or null)
- `data.domain.name` (string)
- `data.domain.expiresAt` (string or null): ISO 8601, UTC (…Z)
- `data.domain.daysLeft` (number or null)
- `data.domain.registrar` (string or null)
- `data.tls` (object)
- `data.tls.expiresAt` (string or null): ISO 8601, UTC (…Z)
- `data.tls.daysLeft` (number or null)
- `data.tls.issuer` (string or null)
- `next_steps` (object[] (optional)): calls that usually come next ({method, path, why, tool})
- `next_steps[].method` (string (optional))
- `next_steps[].path` (string (optional))
- `next_steps[].why` (string (optional))
- `next_steps[].tool` (string (optional)): the MCP tool that makes this call, for data routes

Next steps:
- `GET /api/sites/{slug}/insights`: the same site's daily insights
- `GET /api/sites/{slug}/map`: the site's structure: sections, what changed, what fails
- `GET /api/incidents?site={slug}`: the site's incidents, with likely causes

### GET /api/sites/:slug/insights

One site's daily insights: page weight, security headers, prefetches, page errors, broken links, cache, dead ends. Call this when a site is slow or heavy, or to find what to fix: the daily browser load's page weight, missing security headers, JavaScript errors and broken links.

```
curl -H "Authorization: Bearer sm_…" https://sitesinthewoods.com/api/sites/SITE-SLUG/insights
```

Parameters:
- `slug` (path, string): site slug, as in /api/sites

Response fields:
- `data` (object)
- `data.readers` (object or null): real readers on phones (Chrome UX Report, 28 days); null when Chrome has too little data. Times in ms
- `data.readers.periodEnd` (string)
- `data.readers.lcpP75` (number or null)
- `data.readers.inpP75` (number or null)
- `data.readers.clsP75` (number or null)
- `data.readers.ttfbP75` (number or null)
- `data.pages` (object[]): the homepage and the newest page, measured daily
- `data.pages[].url` (string)
- `data.pages[].latest` (object or null)
- `data.pages[].latest.day` (string)
- `data.pages[].latest.measuredAt` (string): ISO 8601, UTC (…Z)
- `data.pages[].latest.ok` (boolean)
- `data.pages[].latest.error` (string or null)
- `data.pages[].latest.htmlBytes` (number or null)
- `data.pages[].latest.wireBytes` (number or null)
- `data.pages[].latest.scripts` (number or null)
- `data.pages[].latest.jsBytes` (number or null)
- `data.pages[].latest.cssBytes` (number or null)
- `data.pages[].latest.images` (number or null)
- `data.pages[].latest.frameworkBytes` (number or null)
- `data.pages[].latest.headers` (object)
- `data.pages[].latest.headers.grade` (string or null)
- `data.pages[].latest.headers.findings` (object[])
- `data.pages[].latest.headers.findings[].id` (string)
- `data.pages[].latest.headers.findings[].ok` (boolean)
- `data.pages[].latest.headers.findings[].weight` (number)
- `data.pages[].latest.headers.findings[].detail` (string)
- `data.pages[].latest.prefetches` (object)
- `data.pages[].latest.prefetches.requests` (number or null)
- `data.pages[].latest.prefetches.prefetches` (number or null)
- `data.pages[].latest.prefetches.pages` (number or null)
- `data.pages[].latest.prefetches.uncached` (number or null)
- `data.pages[].latest.pageErrors` (object[] or null): null when the browser view didn't run
- `data.pages[].latest.pageErrors[].kind` ("exception" | "console" | "asset")
- `data.pages[].latest.pageErrors[].message` (string)
- `data.pages[].latest.pageErrors[].source` (string or null)
- `data.pages[].latest.pageErrors[].own` (boolean)
- `data.pages[].latest.pageErrors[].count` (number)
- `data.pages[].latest.badgeLinks` (object[] or null): links on the page to our public status pages (an embedded badge, or a plain link); null when not looked for
- `data.pages[].latest.badgeLinks[].href` (string)
- `data.pages[].latest.badgeLinks[].rel` (string): its rel tokens, "" when none
- `data.cache` (object or null): Cloudflare cache over the last 24 hours, across the site's monitored pages
- `data.cache.pages` (integer)
- `data.cache.ok` (integer)
- `data.cache.hits` (integer)
- `data.cache.least` (object or null)
- `data.cache.least.path` (string)
- `data.cache.least.ok` (integer)
- `data.cache.least.hits` (integer)
- `data.brokenLinks` (object[])
- `data.brokenLinks[].page` (string)
- `data.brokenLinks[].links` (object[])
- `data.brokenLinks[].links[].url` (string)
- `data.brokenLinks[].links[].status` (number or null)
- `data.brokenLinks[].links[].error` (string or null)
- `data.pageChecks` (object or null): where people find no way forward: the pages the daily run reads, and one made-up path (latest day of the last 3)
- `data.pageChecks.day` (string)
- `data.pageChecks.pagesSeen` (integer)
- `data.pageChecks.pagesChecked` (integer)
- `data.pageChecks.notFound` (object or null): the answer to one made-up path; null when it didn't run
- `data.pageChecks.notFound.state` ("not_found" | "soft_404" | "login" | "redirect_off_host" | "blocked" | "error")
- `data.pageChecks.notFound.status` (number or null)
- `data.pageChecks.notFound.wayOn` (boolean): a 404 or 410 that links anywhere on the site, or has a search form
- `data.pageChecks.notFound.unconfirmed` (boolean): a bad answer a second made-up path didn't repeat
- `data.pageChecks.navOnly` (string[]): pages whose only links are the navigation
- `data.pageChecks.noWayBack` (object[]): pages with no link to their section
- `data.pageChecks.noWayBack[].page` (string)
- `data.pageChecks.noWayBack[].parent` (string)
- `data.pageChecks.unclearLabels` (integer or null): links whose label says nothing alone (links hidden from assistive technology aren't counted); null when the pages' language isn't covered
- `data.apiChecks` (object[]): where agents find no way forward: up to three keyless GETs a day to the site's own API (latest day of the last 3)
- `data.apiChecks[].spec` (string): the OpenAPI file's URL
- `data.apiChecks[].day` (string)
- `data.apiChecks[].notChecked` (string or null): why nothing was probed (YAML, another host…)
- `data.apiChecks[].probes` (object[])
- `data.apiChecks[].probes[].kind` ("not_found" | "unauthorized" | "list")
- `data.apiChecks[].probes[].url` (string)
- `data.apiChecks[].probes[].state` ("answered" | "blocked" | "redirect" | "error")
- `data.apiChecks[].probes[].status` (number or null)
- `data.apiChecks[].probes[].recovers` (boolean or null): errors: the body says how to recover
- `data.apiChecks[].probes[].paging` (boolean or null): lists: a next link and a way to stop
- `next_steps` (object[] (optional)): calls that usually come next ({method, path, why, tool})
- `next_steps[].method` (string (optional))
- `next_steps[].path` (string (optional))
- `next_steps[].why` (string (optional))
- `next_steps[].tool` (string (optional)): the MCP tool that makes this call, for data routes

Next steps:
- `GET /api/sites/{slug}`: the site's status and last 7 days
- `GET /api/sites/{slug}/scans`: the site's API recovery scans: every API path and sitemap page checked for dead ends, with fixes

### GET /api/sites/:slug/scans

One site's API recovery scans, newest first: state, how each ended, and findings by weight. Call this to see whether a site has been scanned for dead ends (API errors that don't say how to recover, lists without paging, pages nothing links to) and how the last scan came out. Scans are started from the dashboard by an admin or owner.

```
curl -H "Authorization: Bearer sm_…" https://sitesinthewoods.com/api/sites/SITE-SLUG/scans
```

Parameters:
- `slug` (path, string): site slug, as in /api/sites
- `limit` (query, optional, integer, default 20): page size, clamped to 1–100
- `offset` (query, optional, integer, default 0): rows to skip, at most 1000

Response fields:
- `data` (object[])
- `data[].id` (string)
- `data[].state` ("quoting" | "quoted" | "queued" | "running" | "paused" | "done" | "stopped" | "failed")
- `data[].ending` (string or null): how it ended: complete, team_stopped, we_stopped, ownership_lost, plan_changed, site_removed, blocked, budget, error
- `data[].startedAt` (string or null): ISO 8601, UTC (…Z)
- `data[].finishedAt` (string or null): ISO 8601, UTC (…Z)
- `data[].kind` ("scan" | "rescan" | "rerun")
- `data[].findings` (object or null)
- `data[].findings.high` (number)
- `data[].findings.medium` (number)
- `data[].findings.light` (number)
- `data[].findings.warning` (number)
- `limit` (integer): page size used (1–100)
- `offset` (integer): rows skipped
- `has_more` (boolean): another page follows
- `next_steps` (object[] (optional)): calls that usually come next ({method, path, why, tool})
- `next_steps[].method` (string (optional))
- `next_steps[].path` (string (optional))
- `next_steps[].why` (string (optional))
- `next_steps[].tool` (string (optional)): the MCP tool that makes this call, for data routes

Next steps:
- `GET /api/sites/{slug}/scans/{id}`: one scan's findings and fixes
- `GET /api/sites/{slug}/insights`: the site's free daily checks

### GET /api/sites/:slug/scans/:id

One API recovery scan: what it saw, its findings, the fixes and what changed since the last scan. Call this for a scan's results: findings by weight with the places on the site, three to five fixes in words and as a block for a coding agent, and new, fixed and still-open findings since the previous scan. It never includes text from the scanned site.

```
curl -H "Authorization: Bearer sm_…" https://sitesinthewoods.com/api/sites/SITE-SLUG/scans/INCIDENT-ID
```

Parameters:
- `slug` (path, string): site slug, as in /api/sites
- `id` (path, string): scan id, as in /api/sites/{slug}/scans

Response fields:
- `data` (object)
- `data.id` (string)
- `data.state` ("quoting" | "quoted" | "queued" | "running" | "paused" | "done" | "stopped" | "failed")
- `data.ending` (string or null): how it ended: complete, team_stopped, we_stopped, ownership_lost, plan_changed, site_removed, blocked, budget, error
- `data.startedAt` (string or null): ISO 8601, UTC (…Z)
- `data.finishedAt` (string or null): ISO 8601, UTC (…Z)
- `data.kind` ("scan" | "rescan" | "rerun")
- `data.findings` (object or null)
- `data.findings.high` (number)
- `data.findings.medium` (number)
- `data.findings.light` (number)
- `data.findings.warning` (number)
- `data.seen` (object or null): paths probed, pages read, requests…
- `data.items` (object[])
- `data.items[].check` (string)
- `data.items[].weight` ("high" | "medium" | "light" | "warning")
- `data.items[].count` (number)
- `data.items[].places` (string[]): up to 50 paths on the site
- `data.fixes` (object[])
- `data.fixes[].title` (string)
- `data.fixes[].text` (string)
- `data.fixes[].places` (string[])
- `data.fixes[].more` (number)
- `data.agentBlock` (string or null): the fixes for a coding agent, written by our code: no text from the site
- `data.compare` (object or null)
- `data.compare.previous` (string)
- `data.compare.fixed` (number)
- `data.compare.added` (number)
- `data.compare.open` (number)
- `data.compare.notChecked` (number)
- `next_steps` (object[] (optional)): calls that usually come next ({method, path, why, tool})
- `next_steps[].method` (string (optional))
- `next_steps[].path` (string (optional))
- `next_steps[].why` (string (optional))
- `next_steps[].tool` (string (optional)): the MCP tool that makes this call, for data routes

Next steps:
- `GET /api/sites/{slug}/scans`: the site's other scans
- `GET /api/docs`: how to read this

### GET /api/sites/:slug/maintenance

One site's maintenance windows: on now, scheduled, and the last 30 days. Call this to see whether a site is in a maintenance window (its alerts held, its uptime not counting that time) and when the next one is. Windows are started from the dashboard or a deploy calling the site's maintenance URL (POST <url>/start?minutes=30, POST <url>/end), which the dashboard shows to admins.

```
curl -H "Authorization: Bearer sm_…" https://sitesinthewoods.com/api/sites/SITE-SLUG/maintenance
```

Parameters:
- `slug` (path, string): site slug, as in /api/sites

Response fields:
- `data` (object)
- `data.windows` (object[]): newest start first
- `data.windows[].startsAt` (string)
- `data.windows[].endsAt` (string): at most 24 hours after startsAt; an early end shows here
- `data.windows[].state` ("scheduled" | "on" | "ended")
- `data.windows[].scope` ("site" | "project"): this site only, or every site in its project
- `data.windows[].reason` (string or null): the team's own words; never on the public page
- `data.windows[].createdBy` (string): a person, or "maintenance URL"
- `data.windows[].endedBy` (string or null): who ended it early; null when it ran its course
- `next_steps` (object[] (optional)): calls that usually come next ({method, path, why, tool})
- `next_steps[].method` (string (optional))
- `next_steps[].path` (string (optional))
- `next_steps[].why` (string (optional))
- `next_steps[].tool` (string (optional)): the MCP tool that makes this call, for data routes

Next steps:
- `GET /api/sites/{slug}`: the site's status and last 7 days
- `GET /api/incidents?site={slug}`: the site's incidents, held ones included

### GET /api/sites/:slug/map

One site's structure from its sitemaps: sections, new and removed pages, what fails. Call this to see where a site is changing or breaking without crawling it: every path with pages under it, with new and removed pages in the window, pages that fail, broken links and sitemaps that miss pages. Add ?section= for one section's pages. Our sites only (competitors' sitemaps aren't read).

```
curl -H "Authorization: Bearer sm_…" https://sitesinthewoods.com/api/sites/SITE-SLUG/map
```

Parameters:
- `slug` (path, string): site slug, as in /api/sites
- `range` (query, optional, "24h" | "7d" | "30d", default "7d"): the window for new and removed pages
- `section` (query, optional, string): a section path such as "/c" to list its pages

Response fields:
- `data` (object)
- `data.range` (string)
- `data.sitemaps` (string[])
- `data.firstFetchAt` (string or null): pages listed then count as there from the start, never as new
- `data.pages` (number)
- `data.newInWindow` (number)
- `data.removedInWindow` (number)
- `data.checked` (number): pages the monitor checks itself; the rest are known from the sitemap
- `data.linkChecked` (number or null): listed URLs link-checked in the last 7 days, when every sitemap URL is checked
- `data.history` (object[]): the whole site's days in the window (at least two), oldest first; kept 400 days, since monitoring began
- `data.history[].day` (string): YYYY-MM-DD, a UTC day
- `data.history[].pages` (number): pages listed at the day's end
- `data.history[].new` (number)
- `data.history[].removed` (number)
- `data.sections` (object[]): every path with pages under it, largest first within each level; a lone page such as /about is a page, not a section
- `data.sections[].path` (string): "/c/alaska-news" (no trailing slash)
- `data.sections[].depth` (number): 1 for a top-level section
- `data.sections[].pages` (number): live pages at or under this path
- `data.sections[].newInWindow` (number): first seen in the window (not in the sitemap's first fetch)
- `data.sections[].removedInWindow` (number): dropped from every sitemap in the window (removed pages are kept 30 days)
- `data.sections[].newest` (string or null): newest page's content date, else first seen
- `data.sections[].tone` ("up" | "warn" | "down"): up: no known problem; warn: warnings or more than 20% removed; down: a page fails
- `data.sections[].failing` (number): listed URLs that fail
- `data.sections[].brokenLinkPages` (number): pages with an open broken-links incident
- `data.sections[].checked` (number): pages the monitor checks itself
- `data.sections[].missingFrom` (object[]): sitemaps that list at least half the pages here but miss some, and how many they miss
- `data.sections[].missingFrom[].sitemap` (string)
- `data.sections[].missingFrom[].count` (number)
- `data.sections[].history` (object[] or null): a top-level section's days in the window, oldest first; null below the top level
- `data.sections[].history[].day` (string): YYYY-MM-DD, a UTC day
- `data.sections[].history[].pages` (number): pages listed at the day's end
- `data.sections[].history[].new` (number)
- `data.sections[].history[].removed` (number)
- `data.pagesShown` (object[] or null): with ?section=: that section's pages, newest first, at most 1000
- `data.pagesShown[].url` (string)
- `data.pagesShown[].path` (string)
- `data.pagesShown[].title` (string or null)
- `data.pagesShown[].date` (string): content date (published, created, last modified), else first seen
- `data.pagesShown[].isNew` (boolean)
- `data.pagesShown[].checked` (boolean)
- `data.pagesShown[].tone` ("up" | "warn" | "down")
- `data.pagesShown[].fails` (boolean)
- `data.pagesShown[].hasBrokenLinks` (boolean)
- `data.pagesShown[].missingFrom` (string[])
- `next_steps` (object[] (optional)): calls that usually come next ({method, path, why, tool})
- `next_steps[].method` (string (optional))
- `next_steps[].path` (string (optional))
- `next_steps[].why` (string (optional))
- `next_steps[].tool` (string (optional)): the MCP tool that makes this call, for data routes

Next steps:
- `GET /api/sites/{slug}`: the site's status and last 7 days
- `GET /api/incidents?site={slug}`: the site's incidents, with likely causes

### GET /api/sites/:slug/events

What changed on one site: incidents opened and resolved, code pushes, maintenance, new pages. Call this to find what changed before a number moved (clicks fell, pages got slower): the site's timeline, newest first, the same events the dashboard draws on its charts. Page through with limit and offset.

```
curl -H "Authorization: Bearer sm_…" https://sitesinthewoods.com/api/sites/SITE-SLUG/events
```

Parameters:
- `slug` (path, string): site slug, as in /api/sites
- `range` (query, optional, "24h" | "7d" | "30d", default "7d"): the window
- `limit` (query, optional, integer, default 50): page size, clamped to 1–200
- `offset` (query, optional, integer, default 0): rows to skip, at most 1000

Response fields:
- `data` (object[])
- `data[].id` (string): stable id: <source>:<row id>[:resolved]
- `data[].at` (string): ISO 8601, UTC (…Z)
- `data[].kind` ("incident" | "resolved" | "push" | "maintenance" | "paused" | "resumed" | "published")
- `data[].incidentKind` (string (optional)): for incident and resolved events, as in /api/incidents
- `data[].tone` ("down" | "warning" | "change"): a problem in its severity, or a change
- `data[].glyph` ("problem" | "search" | "config" | "push" | "published" | "paused"): what kind of change: drawn as the chart rail's shape
- `data[].label` (string): one line in our words; for a push, its commit's first line
- `data[].detail` (string or null (optional)): an incident's cause, a push's repo and author, a window's reason
- `data[].before` (string (optional))
- `data[].after` (string (optional))
- `data[].href` (string (optional)): the commit, or the incident on the dashboard
- `data[].targetId` (string or null (optional))
- `data[].until` (string (optional)): a maintenance window's end
- `limit` (integer): page size used (1–100)
- `offset` (integer): rows skipped
- `has_more` (boolean): another page follows
- `next_steps` (object[] (optional)): calls that usually come next ({method, path, why, tool})
- `next_steps[].method` (string (optional))
- `next_steps[].path` (string (optional))
- `next_steps[].why` (string (optional))
- `next_steps[].tool` (string (optional)): the MCP tool that makes this call, for data routes

Next steps:
- `GET /api/sites/{slug}/insights`: the site's traffic, speed and search
- `GET /api/incidents?site={slug}`: the site's incidents, with likely causes

### GET /api/incidents

Incidents, open now or recent; open outages and slowdowns carry the likely cause. Call this to see what went wrong and why: open and recent incidents, newest first, with the likely cause on open outages and slowdowns. Page through with limit and offset.

```
curl -H "Authorization: Bearer sm_…" https://sitesinthewoods.com/api/incidents
```

Parameters:
- `state` (query, optional, "open" | "recent", default "open"): open: open now; recent: newest first, open or closed
- `site` (query, optional, string): site slug
- `limit` (query, optional, integer, default 20): page size, clamped to 1–100
- `offset` (query, optional, integer, default 0): rows to skip, at most 1000

Response fields:
- `data` (object[])
- `data[].id` (string)
- `data[].kind` (string)
- `data[].label` (string)
- `data[].severity` ("down" | "warning")
- `data[].site` (string or null): site slug
- `data[].url` (string or null): the page or file it's about
- `data[].domain` (string or null)
- `data[].startedAt` (string): ISO 8601, UTC (…Z)
- `data[].resolvedAt` (string or null): ISO 8601, UTC (…Z)
- `data[].cause` (string or null)
- `data[].details` (object)
- `data[].dismissed` (object or null): the team marked it as noise: still open, never alerts again
- `data[].dismissed.by` (string)
- `data[].dismissed.at` (string): ISO 8601, UTC (…Z)
- `data[].likelyCause` (object or null (optional)): open outages and slowdowns only: the monitor's rules, as in the alert
- `data[].likelyCause.likely` (string or null)
- `data[].likelyCause.clues` (string[])
- `limit` (integer): page size used (1–100)
- `offset` (integer): rows skipped
- `has_more` (boolean): another page follows
- `next_steps` (object[] (optional)): calls that usually come next ({method, path, why, tool})
- `next_steps[].method` (string (optional))
- `next_steps[].path` (string (optional))
- `next_steps[].why` (string (optional))
- `next_steps[].tool` (string (optional)): the MCP tool that makes this call, for data routes

Next steps:
- `GET /api/sites/{slug}`: the affected site in detail

### GET /api/domains

The team's domains: registration expiry, registrar, nameservers, status. Call this to check renewals: which domains expire soon, who the registrar is, and whether nameservers or registry locks changed.

```
curl -H "Authorization: Bearer sm_…" https://sitesinthewoods.com/api/domains
```

Response fields:
- `data` (object[])
- `data[].name` (string)
- `data[].expiresAt` (string or null): ISO 8601, UTC (…Z)
- `data[].daysLeft` (number or null)
- `data[].registrar` (string or null)
- `data[].nameservers` (string[])
- `data[].statusFlags` (string[])
- `data[].lastCheckedAt` (string or null): ISO 8601, UTC (…Z)
- `data[].sites` (string[])
- `next_steps` (object[] (optional)): calls that usually come next ({method, path, why, tool})
- `next_steps[].method` (string (optional))
- `next_steps[].path` (string (optional))
- `next_steps[].why` (string (optional))
- `next_steps[].tool` (string (optional)): the MCP tool that makes this call, for data routes

Next steps:
- `GET /api/status`: every site's status right now

### POST /api/incidents/:id/dismiss

Dismiss an open incident as noise. Hides it from the open lists for the whole team; it never alerts again and closes without a message. Not every kind can be dismissed (409). Needs a Member or Admin key, on a team with 10 sites or more.

```
curl -X POST -H "Authorization: Bearer sm_…" https://sitesinthewoods.com/api/incidents/INCIDENT-ID/dismiss
```

Parameters:
- `id` (path, string): incident id, as in /api/incidents

Response fields:
- `data` (object)
- `data.id` (string)
- `data.kind` (string)
- `data.site` (string or null): its site's slug
- `data.dismissed` (boolean)
- `data.recheckRequested` (boolean)
- `next_steps` (object[] (optional)): calls that usually come next ({method, path, why, tool})
- `next_steps[].method` (string (optional))
- `next_steps[].path` (string (optional))
- `next_steps[].why` (string (optional))
- `next_steps[].tool` (string (optional)): the MCP tool that makes this call, for data routes

Next steps:
- `GET /api/incidents`: the incidents as they are now

### POST /api/incidents/:id/undismiss

Bring back a dismissed incident. Undoes a dismiss: the incident shows and alerts again. Needs a Member or Admin key, on a team with 10 sites or more.

```
curl -X POST -H "Authorization: Bearer sm_…" https://sitesinthewoods.com/api/incidents/INCIDENT-ID/undismiss
```

Parameters:
- `id` (path, string): incident id, as in /api/incidents

Response fields:
- `data` (object)
- `data.id` (string)
- `data.kind` (string)
- `data.site` (string or null): its site's slug
- `data.dismissed` (boolean)
- `data.recheckRequested` (boolean)
- `next_steps` (object[] (optional)): calls that usually come next ({method, path, why, tool})
- `next_steps[].method` (string (optional))
- `next_steps[].path` (string (optional))
- `next_steps[].why` (string (optional))
- `next_steps[].tool` (string (optional)): the MCP tool that makes this call, for data routes

Next steps:
- `GET /api/incidents`: the incidents as they are now

### POST /api/incidents/:id/recheck

Check an incident again now. The monitor checks it again within 30 seconds, after a fix, instead of waiting for the next scheduled check. Not every kind can be checked again (409). Needs a Member or Admin key, on a team with 10 sites or more.

```
curl -X POST -H "Authorization: Bearer sm_…" https://sitesinthewoods.com/api/incidents/INCIDENT-ID/recheck
```

Parameters:
- `id` (path, string): incident id, as in /api/incidents

Response fields:
- `data` (object)
- `data.id` (string)
- `data.kind` (string)
- `data.site` (string or null): its site's slug
- `data.dismissed` (boolean)
- `data.recheckRequested` (boolean)
- `next_steps` (object[] (optional)): calls that usually come next ({method, path, why, tool})
- `next_steps[].method` (string (optional))
- `next_steps[].path` (string (optional))
- `next_steps[].why` (string (optional))
- `next_steps[].tool` (string (optional)): the MCP tool that makes this call, for data routes

Next steps:
- `GET /api/incidents`: the incidents as they are now

### POST /api/sites/:slug/maintenance/start

Start a maintenance window on a site now. Call this before a deploy: alerts for the site are held (checks still run) until the window ends, after `minutes` (default 30, at most 24 hours) or when you end it. Starting again replaces the open window. Needs a Member or Admin key, on a team with 10 sites or more.

```
curl -X POST -H "Authorization: Bearer sm_…" -H "content-type: application/json" -d '{"minutes":30,"reason":"deploy"}' https://sitesinthewoods.com/api/sites/SITE-SLUG/maintenance/start
```

Parameters:
- `slug` (path, string): site slug, as in /api/sites
- `minutes` (body, optional, integer): how long, default 30
- `reason` (body, optional, string): the team's own words; never public

Response fields:
- `data` (object)
- `data.id` (string)
- `data.startsAt` (string): ISO 8601, UTC (…Z)
- `data.endsAt` (string): ISO 8601, UTC (…Z)
- `data.reason` (string or null)
- `next_steps` (object[] (optional)): calls that usually come next ({method, path, why, tool})
- `next_steps[].method` (string (optional))
- `next_steps[].path` (string (optional))
- `next_steps[].why` (string (optional))
- `next_steps[].tool` (string (optional)): the MCP tool that makes this call, for data routes

Next steps:
- `GET /api/sites/{slug}/maintenance`: the site's windows
- `GET /api/sites/{slug}`: the site after the deploy

### POST /api/sites/:slug/maintenance/end

End a site's maintenance windows now. Call this after a deploy: alerts for the site go out again from now. Ending with no window on answers `ended: 0`. Needs a Member or Admin key, on a team with 10 sites or more.

```
curl -X POST -H "Authorization: Bearer sm_…" https://sitesinthewoods.com/api/sites/SITE-SLUG/maintenance/end
```

Parameters:
- `slug` (path, string): site slug, as in /api/sites

Response fields:
- `data` (object)
- `data.ended` (integer): windows ended
- `next_steps` (object[] (optional)): calls that usually come next ({method, path, why, tool})
- `next_steps[].method` (string (optional))
- `next_steps[].path` (string (optional))
- `next_steps[].why` (string (optional))
- `next_steps[].tool` (string (optional)): the MCP tool that makes this call, for data routes

Next steps:
- `GET /api/sites/{slug}`: the site now

### POST /api/sites/:slug/pause

Pause a site's checks. Stops every check of the site, keeping its history, until it's resumed. Nothing alerts while it's paused. Needs an Admin key, on a team with 10 sites or more.

```
curl -X POST -H "Authorization: Bearer sm_…" https://sitesinthewoods.com/api/sites/SITE-SLUG/pause
```

Parameters:
- `slug` (path, string): site slug, as in /api/sites

Response fields:
- `data` (object)
- `data.slug` (string)
- `data.paused` (boolean)
- `next_steps` (object[] (optional)): calls that usually come next ({method, path, why, tool})
- `next_steps[].method` (string (optional))
- `next_steps[].path` (string (optional))
- `next_steps[].why` (string (optional))
- `next_steps[].tool` (string (optional)): the MCP tool that makes this call, for data routes

Next steps:
- `GET /api/sites/{slug}`: the site now

### POST /api/sites/:slug/resume

Resume a paused site's checks. Starts the site's checks again within a minute. Needs an Admin key, on a team with 10 sites or more.

```
curl -X POST -H "Authorization: Bearer sm_…" https://sitesinthewoods.com/api/sites/SITE-SLUG/resume
```

Parameters:
- `slug` (path, string): site slug, as in /api/sites

Response fields:
- `data` (object)
- `data.slug` (string)
- `data.paused` (boolean)
- `next_steps` (object[] (optional)): calls that usually come next ({method, path, why, tool})
- `next_steps[].method` (string (optional))
- `next_steps[].path` (string (optional))
- `next_steps[].why` (string (optional))
- `next_steps[].tool` (string (optional)): the MCP tool that makes this call, for data routes

Next steps:
- `GET /api/sites/{slug}`: the site now
