Audit runs API
Check a URL, start audits, poll them and read the results.
5 live operations. Built from the OpenAPI contract at every release, so this page never lists an endpoint that does not work. Paths are relative to the base URL.
To try these with your own account, sign in and open Automation → Try the API in the app.
Run the URL policy without starting an audit
Request body
{
"url": "https://www.example.com"
}Responses
Policy result
3 fields
RFC 9457 problem
Try it: signed in, open this operation in the app. It runs against your own account, with no key to paste.
List audit runs, newest first
Parameters
Filter by a label, `key:value`.
Responses
Runs, newest first
2 fields
21 fields of data
Set when `status` is `failed`, for example `url_policy_denied`, or `verification_lost` when the ownership proof of a deep audit is gone.
One of: queued, running, succeeded, partial, failed
One of: manual, scheduled, api, ci
`passive` reads what every visitor sees and runs on any public site. `deep` adds requests a visitor would not make (for example files that should not be public) and runs only on a verified site.
One of: passive, deep
The scope as it was when the audit was started.
3 fields of scope
The sum of the credits of the checks in this audit.
Credits booked when the audit finished. 0 when it could not start; `null` while it runs.
6 fields of runtimeMetrics
7 fields of summary
One of: availability, security, email, performance, marketing, accessibility, privacy, technology, exposure
Free key-value pairs, e.g. release, pipeline, NeoLoad test ID, Jira key.
RFC 9457 problem
Try it: signed in, open this operation in the app. It runs against your own account, with no key to paste.
Queue an audit. Returns at once; the run is asynchronous.
Parameters
Same key within 24 h returns the same response; a different body returns 409.
Request body AuditRunCreate
`deep` answers 403 `verification_required` unless the site is verified.
Default: passive
Which checks to run: `full`, `area:<area>` or the id of a saved scope (`GET /audit-scopes`). A passive audit runs the passive checks of the scope; if there are none, 400 `empty_scope`.
Default: full
An own selection of checks for this one run, without saving a scope: check ids from `GET /rules`. Send either `scope` or `ruleIds`, not both (400 `invalid_request`). The run reports the scope `custom`. A passive audit runs the passive checks of the selection; if there are none, 400 `empty_scope`.
Defaults to the site's deep-audit pages.
At most 20 items
Default: prof_mobile_v1
Start no earlier than this time (within 90 days). Omit to start now.
`previous` (default), `none`, or a run ID to compare with.
Free key-value pairs, e.g. release, pipeline, NeoLoad test ID, Jira key.
{
"siteId": "site_01JC9Z0000000000000000000"
}Responses
Accepted
Header Location
21 fields
Set when `status` is `failed`, for example `url_policy_denied`, or `verification_lost` when the ownership proof of a deep audit is gone.
One of: queued, running, succeeded, partial, failed
One of: manual, scheduled, api, ci
`passive` reads what every visitor sees and runs on any public site. `deep` adds requests a visitor would not make (for example files that should not be public) and runs only on a verified site.
One of: passive, deep
The scope as it was when the audit was started.
3 fields of scope
The sum of the credits of the checks in this audit.
Credits booked when the audit finished. 0 when it could not start; `null` while it runs.
6 fields of runtimeMetrics
7 fields of summary
One of: availability, security, email, performance, marketing, accessibility, privacy, technology, exposure
Free key-value pairs, e.g. release, pipeline, NeoLoad test ID, Jira key.
RFC 9457 problem
RFC 9457 problem
RFC 9457 problem
Try it: signed in, open this operation in the app. It runs against your own account, with no key to paste.
Get one audit run; poll this until the status is final
Parameters
Long-poll up to this many seconds while the run is not final.
Responses
Run
Header Retry-After: Present while the run is queued or running.
21 fields
Set when `status` is `failed`, for example `url_policy_denied`, or `verification_lost` when the ownership proof of a deep audit is gone.
One of: queued, running, succeeded, partial, failed
One of: manual, scheduled, api, ci
`passive` reads what every visitor sees and runs on any public site. `deep` adds requests a visitor would not make (for example files that should not be public) and runs only on a verified site.
One of: passive, deep
The scope as it was when the audit was started.
3 fields of scope
The sum of the credits of the checks in this audit.
Credits booked when the audit finished. 0 when it could not start; `null` while it runs.
6 fields of runtimeMetrics
7 fields of summary
One of: availability, security, email, performance, marketing, accessibility, privacy, technology, exposure
Free key-value pairs, e.g. release, pipeline, NeoLoad test ID, Jira key.
RFC 9457 problem
Try it: signed in, open this operation in the app. It runs against your own account, with no key to paste.
The results of one audit run, one per check
Parameters
`failed` means the measurement failed, not the site.
Responses
Observations
2 fields
19 fields of data
One of: availability, security, email, performance, marketing, accessibility, privacy, technology, exposure
`failed` means the measurement failed, not the site.
One of: pass, fail, no_data, not_tested, failed
One of: info, low, medium, high
One of: low, medium, high
One of: status, metric, score
Noise band for the metric; a change inside it is `unchanged`.
One of: improved, regressed, unchanged, no_data
RFC 9457 problem
Try it: signed in, open this operation in the app. It runs against your own account, with no key to paste.