FeaturePOST /v1/checks/*

Page Checks API

When you need one focused answer per URL — not a full facts pack: visibility, security, axe a11y, or tech facts.

What you can do with page checks

Focused single checks instead of a large facts pack: element visibility, security signals, axe a11y, or tech inventory — each with a clear endpoint.

Visibility: exists, visible, in viewport, not obscured
Security: TLS/header/mixed-content facts
A11y: raw axe output
Tech: framework/CMS/analytics hints

API Call

editable

Request body

{'{'}

{'}'}

Switch endpoint — selector, viewport, and cookie banner are editable.

Response

Security check

example.com

Structured check facts — details in the Response tab.

Endpoints & parameters

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

POST /v1/checks/visibility

Checks a selector for visibility and optional expect rules.

Example request

json

{
  "url": "https://example.com",
  "selector": "a[href*=\"pricing\"]",
  "scroll_into_view": true,
  "dismiss_cookie_banner": true,
  "expect": {
    "href_contains": "pricing"
  },
  "width": 1280,
  "height": 720
}

Parameters

urlstring required
Target URL.
selectorstring required
CSS selector of the element.
expectobject
Optional: attribute {name,value} or href_contains.
scroll_into_viewboolean
Scroll element into viewport before check.
ignore_selectorsstring[]
Ignore overlays (e.g. cookie banner).
wait_for_selector / settle_ms / timeoutsvarious
Timing control.
width / height / dismiss_cookie_bannervarious
Viewport and banner.