Get scan details API in Website Scanner
Use this API to get a high-level summary of a website scan.
get scan details
If Geo Region Restriction (GRR) is enabled for your account, add your region code to the host name:
api-accessibility-<region>.browserstack.com. See Geo Region Restriction endpoints for the region codes and examples.
Request parameters
Request
curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
https://api-accessibility.browserstack.com/api/website-scanner/v1/scans/{scan_id}/overview
-
proj_id* Integer
The unique ID of the scan project.
-
current_user_id String
The user ID of the current user making the 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"
]
}
-
success Boolean
Indicates whether the request was successful.
-
data Object
â–¶ SHOW VALUESThe scan configuration object.
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.