Get scan details API in Website Scanner
Use this API to get a high-level summary of a website scan.
get scan details
For geo-restricted data, use the following endpoints:
https://accessibility-eu.browserstack.com/api/website-scanner/v1/scans/{scan_id}/overview (European Union)
https://accessibility-in.browserstack.com/api/website-scanner/v1/scans/{scan_id}/overview (India)
Request parameters
Request
curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
https://api-accessibility.browserstack.com/api/website-scanner/v1/scans/{scan_id}/overview
-
next_page String
Used to fetch subsequent pages from the API when has_next parameter is true. Pass the next_page reference received in the response of last request.
Response Attributes 200 OK JSON
Response
"data": {
"scanConfigInfo": {
"name": "Browserstack demo",
"scanConfigId": 1199,
"createdBy": {
"id": 6456742,
"name": "John Doe"
},
"wcagVersion": "WCAG 2.1 AA",
"needsReview": true,
"bestPractices": false,
"recurring": true,
"advanced": false,
"pageCount": 3,
"nextScanDate": "2024-10-03T06:30:00.000Z",
"active": true,
"isProcessing": false,
"authEnabled": false,
"localTestingEnabled": false
},
"urlList": [
"https://sample1.com",
"https://sample2.com",
"https://sample3.com"
]
}
-
scanConfigInfo Object
▶ SHOW VALUESContains basic configuration details of the website scan.
-
name String
Name of the scan.
-
scanConfigId Integer
Unique ID of the scan.
-
createdBy Object
▶ SHOW VALUESName and ID of the scan creator.
-
name String
Name of the scan creator.
-
id Integer
ID of the scan creator.
-
-
-
wcagVersion String
The WCAG version used for the analysis.
-
needsReview Boolean
True if issues that require manual confirmation are included.
-
bestPractices Boolean
True if best practices rules are included. These are not WCAG violations but are good to have to ensure accessibility.
-
recurring Boolean
True if the scan is a recurring one.
- Show 9 more
-
advanced Boolean
True if reporting of issues in violation of advanced rules is enabled.
-
pageCount Integer
Number of pages in the scan.
-
nextScanDate String
Timestamp of the next scheduled scan.
-
active Boolean
True if the scan is active.
-
isProcessing Boolean
True if the scan is still being processed.
-
authEnabled Boolean
True if authorization is enabled in the scan.
-
localTestingEnabled Boolean
True if local testing is enabled in the scan.
-
urlList Array
A list of URLs that were scanned.
-
pagination Object
▶ SHOW VALUESContains information to facilitate fetching additional records if they exist.
-
has_next Boolean
True if there are more records to fetch. False if the current response is the last page of records.
-
next_page String
A reference to the next page. Pass this as a request parameter in the subsequent request as “next_page” to get the next page of records.
-
We're sorry to hear that. Please share your feedback so we can do better
Contact our Support team for immediate help while we work on improving our docs.