Skip to main content
POST
POST
Starts a new audit scan for the specified website. The scan runs asynchronously — poll Scan Status to track progress. Requires the scan:full_scan:add permission.
Each scan consumes credits from the organisation’s plan quota. Check the subscription before starting large scans.

​
Request Body

​
string
required
UUID of the website to scan.
​
string
default:"full"
Scan depth: quick, full, or custom.
​
string
default:"desktop"
Device type to emulate: mobile or desktop.
​
integer
default:"0"
Maximum pages to crawl. 0 means unlimited (up to the plan limit).
​
object
Custom audit configuration.
  • audit_types: array of "accessibility", "performance", "seo", "quality"
  • standards: array of "wcag2.1aa", "wcag2.2aa", "ADA", "EN301549"
​
array
URL patterns (substrings) to include in the crawl.
​
array
URL patterns (substrings) to exclude from the crawl.

​
Response

​
boolean
true when the scan has been queued.
​
object
The created scan object — includes id (audit_id), status, scan_type, audit_start_time.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
website_id
string<uuid>
required
​
scan_type
enum<string>
default:full
Available options:
quick,
full,
custom
​
audit_device
enum<string>
default:desktop
Available options:
mobile,
desktop
​
max_number_of_pages
integer
default:0

0 = unlimited

​
json_audit_list
object

{ audit_types: [...], standards: [...] }

Example:
​
json_include_links
string[]

URL patterns to include

​
json_exclude_links
string[]

URL patterns to exclude

Response

Scan started

​
success
boolean
​
data
object