Accessibility Scan Object


A site-scoped accessibility scan.

Running a scan creates this asynchronous resource. Poll it while it is QUEUED or RUNNING. Read findings only after it reaches COMPLETED or PARTIALLY_COMPLETED; when it reaches FAILED, inspect failure and start a new scan after correcting the cause. The Wix site is always derived from the authenticated caller context. Published sites use their published version; unpublished sites use their latest saved version.

Properties
completedDatestringRead-onlyformat date-time

Date and time the scan reached a terminal state.


createdDatestringRead-onlyformat date-time

Date and time the scan was queued.


failureAccessibilityScanFailureRead-only

Public, sanitized failure details. Populated only when status is FAILED.


idstringRead-onlyformat GUID

Server-generated scan ID.


progressAccessibilityScanProgressRead-only

Page-processing progress. Updated throughout the scan and retained when the scan reaches a terminal state.


resultsExpirationDatestringRead-onlyformat date-time

Date and time the stored scan results expire.


revisionstringRead-only

Revision number used for optimistic concurrency.


startedDatestringRead-onlyformat date-time

Date and time processing started.


statusstringRead-only

summaryAccessibilityScanSummaryRead-only

Aggregate results. Populated for completed and partially completed scans.


targetAccessibilityScanTargetimmutable

What this scan checks. Immutable after the scan is created.


updatedDatestringRead-onlyformat date-time

Date and time this resource last changed.

Did this help?