FeaturePOST /v1/checks/a11y-snapshot

Accessibility Facts

A11y snapshots as browser facts. Violations, passes, and impact levels — structured for your pipeline, not qualitative scores.

Browser facts docs

What you can do with accessibility facts

Scout delivers a11y as structured raw data — either as a quick inventory (headings, links, landmarks) or a full axe run. No soft judgments, just facts for CI and agents.

A11y snapshot: inventories without an axe run
Raw axe violations including nodes and impact
Viewport controls what is visible and counted in the snapshot
Usable as a release gate or regression check in pipelines

API Call

editable

Request body

{'{'}

{'}'}

A11y snapshot: viewport changes inventories (headings, links, …).

Response

—

Headings

—

Links

—

Buttons

—

Landmarks

A11y snapshot from a real browser — structured raw data for your checks.

Endpoints & parameters

Choose an endpoint — below you'll see an example request and explanations for all relevant parameters.

POST /v1/checks/a11y-snapshot

Structural a11y inventory (no axe violations).

Example request

json

{
  "url": "https://example.com",
  "width": 1280,
  "height": 720,
  "dismiss_cookie_banner": true
}

Parameters

urlstring required
Target URL.
width / heightnumber
Viewport — affects buttons, links, and landmarks in the snapshot.
settle_ms / goto_timeout_msnumber
Load and settle timeouts.
dismiss_cookie_bannerboolean
Attempts to dismiss known cookie banners before measuring or checking.
wait_for_selectorstring
Waits for a CSS selector before continuing.
wait_ms / settle_msnumber
Additional wait time after loading (depends on endpoint).
devicestring
Playwright device preset; overrides width/height/UA when set.
color_scheme'light'|'dark'|'no-preference'
Preferred color scheme in the browser.
block_adsboolean
Blocks known ad and tracker requests.
capture_xhrstring
Glob or substring for XHR/fetch URLs whose bodies Scout captures (max. 20).
fetch_mode'browser'|'http'
http loads without JavaScript (static document). Default: browser.
solve_captchaboolean
Best-effort Turnstile/checkbox on your own sites. Cloud: domain verify. Self-host: always allowed.
record_harboolean
Optionally records HAR (where supported by the endpoint).
respect_robotsboolean
Respect robots.txt (default: on).