API Scan API
Check your whole site after every deploy.
Start a scan from your pipeline, and read back what it found: expired offers, prices that disagree, placeholder text and buttons that go nowhere.
20 API calls per scan. Reading its progress and results is one call.
What you get
What it does for you
One call to start
Run it from any deploy step, and get an id back straight away.
Findings you can act on
Each has a severity, the page, the exact words quoted, why it matters and a suggested fix.
A score to track
An overall score and the number of pages checked, so you can see the trend.
Fix prompts
Each finding comes with a prompt to paste into your AI coding tool.
How it works
What it looks like in your code
Start a scan
POST /v1/scan
{
"id": "abc123",
"status": "queued"
}Read the result
GET /v1/scan/abc123
{
"id": "abc123",
"status": "done",
"score": 84,
"pagesScanned": 42,
"findings": [{
"severity": "high",
"title": "...",
"pageUrl": "https://yourshop.com/pricing",
"quote": "...",
"why": "...",
"suggestedFix": "..."
}]
}Good to know
What it can't do
- It comes with the Prices bundle or Everything, on a verified site, with a key tied to that site.
- It scans the site the key belongs to, not any address.
- Findings are automated and can be wrong, so check them before acting.
FAQ
Questions, answered
- Can I try it first?
- Yes. The free scan on our site runs the same kind of check on any address, with no account.
- How many pages does it check?
- Up to 100 pages with the Prices bundle, and 300 with Everything.