POST

Run Accessibility Scan


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Queues an asynchronous accessibility scan.

Retrying with the same idempotencyKey for the same site returns the original scan. Reusing the key with a different target fails.

Fails if the target is invalid or unavailable, another scan for the same target is active, the idempotency key was reused for another target, or the supported scan size is exceeded. Multi-page targets are never silently sampled or truncated. Run requests are limited to 5 per minute per Wix site and can return HTTP 429. Retry the same intended scan with the same idempotency key.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Accessibility Scans
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/accessibility/v1/accessibility-scans/run

Errors
400Invalid Argument

There is 1 error with this status code.

428Failed Precondition

There are 3 errors with this status code.

429Resource Exhausted

There is 1 error with this status code.

503Unavailable

There is 1 error with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Did this help?