Get scan run summary API in Website Scanner
Use this API to get a high-level summary of a scan run report from a website scan.
get scan run summary
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} (European Union)
https://accessibility.browserstack.com/api/website-scanner/v1/scans/{scan_id}/scan_runs/{scan_run_id} (United States)
https://accessibility-in.browserstack.com/api/website-scanner/v1/scans/{scan_id}/scan_runs/{scan_run_id} (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}
-
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.
-
product String
The product type for which to retrieve the report. Use
accessibilityto get the accessibility report.
Response Attributes 200 OK JSON
Response
{
"scan_id": 83215,
"scan_run_id": 292167,
"time": "2024-09-30T06:30:00.000Z",
"needsReview": true,
"bestPractices": false,
"advanced": true,
"wcagVersion": "WCAG 2.1 AA",
"engineInfo": {
"name": "a11y_engine",
"version": "3.3.0"
},
"authEnabled": false,
"localTestingEnabled": false,
"status": "Complete",
"changesSinceLastRun": {
"newIssues": 165,
"retainedIssues": 120,
"resolvedIssues": 177
},
"scoreData": {
"score": 30,
"impact": {
"critical": 0,
"criticalPassed": 0,
"criticalFailed": 0,
"serious": 61,
"seriousPassed": 1,
"seriousFailed": 1,
"moderate": 0,
"moderatePassed": 0,
"moderateFailed": 0,
"minor": 9,
"minorPassed": 0,
"minorFailed": 1
}
},
"issueSummary": {
"componentCount": 63,
"issueCount": 784,
"pageCount": 54,
"needsReview": 568,
"hidden": 0
},
"issueCount": {
"issueCountBySeverity": {
"minor": 0,
"serious": 708,
"critical": 76,
"moderate": 0
},
"issueCountByURL": [
{
"url": "https://sample1.com",
"count": 58
},
{
...
},
...
],
"issueCountByComponent": [
{
"componentId": "A#main-nav__link",
"count": 174
},
{
...
},
...
],
"issueCountByCategory": [
{
"count": 0,
"category": "keyboard"
},
{
...
},
...
],
"pagination": {
"has_next": true,
"next_page": "eyJhbGciOiJIUzI1NiJ9.eyJwYWdlIjoxLCJwYWdlX3NpemUiOjEwLCJidWlsZF91dWlkIjoic3pkdGplMnhsaHNydWZkajF3bnJnYnZndnNmZzJjdGRsdWt4Nnl5eCIsImV4cCI6MTczNjY4NDA1OH0.sLI7hWQwE_bB6AB-ORgz1K6D2VIHqH_H39qK8Jh3HqA"
}
}
}
-
accessibility Object
â–¶ SHOW VALUESAccessibility scan summary for this run.
-
percy Object
â–¶ SHOW VALUESVisual testing (Percy) summary for this run. Present only when Percy is enabled for the project.
-
functional Object
â–¶ SHOW VALUESFunctional scan summary for this run. Present only when functional scanning is enabled.
-
performance Object
â–¶ SHOW VALUESPerformance scan summary for this run. Present only when performance scanning is enabled.
-
responsive Object
â–¶ SHOW VALUESResponsive design testing summary for this run. Present only when responsive testing is enabled.
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.