Get scan run status API in Website Scanner
Use this API to to check the status of a scan run.
get scan run status
For geo-restricted data, use the following endpoints:
https://accessibility-eu.browserstack.com/api/website-scanner/v1/scans/{scan_id}/scan_runs/{scan_run_id}/status (European Union)
https://accessibility.browserstack.com/api/website-scanner/v1/scans/{scan_id}/scan_runs/{scan_run_id}/status (United States)
https://accessibility-in.browserstack.com/api/website-scanner/v1/scans/{scan_id}/scan_runs/{scan_run_id}/status (India)
Request parameters
Request
curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
https://api-accessibility.browserstack.com/api/website-scanner/v1/scans/{scan_id}/scan_runs/{scan_run_id}/status
-
proj_id* Integer
The unique ID of the scan project.
-
report_id* Integer
The unique ID of the scan run report.
-
current_user_id String
The user ID of the current user making the request.
Response Attributes 200 OK JSON
Response
{
"success": true,
"data":{
"scan_id": 1234,
"scan_run_id": 5678,
"status": "completed"
},
"error": null
}
-
success Boolean
Indicates whether the request was successful.
-
status String
The current status of the scan run. Possible values are
queued,processing,finalizing,completed, orfailed.
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.