FeaturePOST /v1/checks/a11y-snapshot

Accessibility Facts

A11y-Snapshots als Teil der Browser-Facts. Violations, Passes und Impact-Levels — strukturiert für deine Pipeline, nicht als qualitative Urteile.

Browser-Facts Docs

Was du mit Accessibility-Facts machen kannst

Scout liefert A11y als strukturierte Rohdaten — entweder als schnelles Inventory (Headings, Links, Landmarks) oder als vollständigen axe-Lauf. Keine Soft-Urteile, sondern Facts für CI und Agenten.

A11y-Snapshot: Inventories ohne axe-Lauf
Raw axe Violations inkl. Nodes und Impact
Viewport steuert, was im Snapshot sichtbar/gezählt wird
Als Release-Gate oder Regression-Check in Pipelines nutzbar

API Call

editable

Request body

{'{'}

{'}'}

A11y-Snapshot: Viewport ändert Inventories (Headings, Links, …).

Response

—

Headings

—

Links

—

Buttons

—

Landmarks

A11y-Snapshot aus dem echten Browser — strukturierte Rohdaten für deine Checks.

Endpoints & Parameter

Endpoint wählen — darunter siehst du eine beispielhafte Anfrage und die Erklärung aller relevanten Parameter.

POST /v1/checks/a11y-snapshot

Strukturelles A11y-Inventory (keine axe Violations).

Beispiel-Anfrage

json

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

Parameter

urlstring required
Ziel-URL.
width / heightnumber
Viewport — beeinflusst Buttons/Links/Landmarks im Snapshot.
settle_ms / goto_timeout_msnumber
Lade-/Settle-Timeouts.
dismiss_cookie_bannerboolean
Versucht bekannte Cookie-Banner zu schließen, bevor gemessen/geprüft wird.
wait_for_selectorstring
Wartet auf CSS-Selector, bevor weitergemacht wird.
wait_ms / settle_msnumber
Zusätzliche Wartezeit nach dem Laden (je nach Endpoint).
devicestring
Playwright-Device-Preset; überschreibt width/height/UA wenn gesetzt.
color_scheme'light'|'dark'|'no-preference'
Bevorzugtes Farbschema im Browser.
block_adsboolean
Blockiert bekannte Ad-/Tracker-Requests.
record_harboolean
Zeichnet optional HAR auf (wo vom Endpoint unterstützt).
respect_robotsboolean
Robots.txt beachten (Default: an).