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

GET /api/v1/scanner/{proj_id}/scan_builds/{report_id}

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}/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 accessibility to 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

Accessibility scan summary for this run.

▶ SHOW VALUES
- score Integer
  
  The accessibility score for this scan run (0–100).
- status String
  
  The status of the accessibility scan. Possible values are completed or failed.
- pdfScan Object
  
  PDF scan details, if applicable. Returns null if no PDF scan was performed.
- pageCount Integer
  
  The number of pages for which the accessibility scan completed.
- issueCount Integer
  
  The total number of accessibility issues found.
- buildStability Integer
  
  The number of pages that were successfully scanned for accessibility.
- componentCount Integer
  
  The number of unique UI components affected by accessibility issues.
percy Object

Visual testing (Percy) summary for this run. Present only when Percy is enabled for the project.

▶ SHOW VALUES
- state String
  
  The processing state of the Percy build (for example, finished).
- status String
  
  The status of the Percy scan. Possible values are completed or failed.
- webUrl String
  
  The URL to view the Percy build report.
- reviewState String
  
  The review state of the Percy build (for example, approved or unreviewed).
- totalSnapshots Integer
  
  The total number of snapshots captured.
- totalTestCases Integer
  
  The total number of test cases associated with the Percy build.
- totalComparisons Integer
  
  The total number of visual comparisons performed.
- reviewStateReason String
  
  The reason for the current review state (for example, project_first_build).
- totalOpenComments Integer
  
  The number of open comments on this Percy build.
- totalComparisonsDiff Integer
  
  The number of comparisons that have visual differences.
- totalTestCasesFailed Integer
  
  The number of test cases that failed.
- totalSnapshotsRejected Integer
  
  The number of snapshots rejected. Returns null if none.
- totalComparisonsFinished Integer
  
  The number of comparisons that have finished processing.
- totalSnapshotsUnreviewed Integer
  
  The number of snapshots that have not yet been reviewed.
- totalTestCasesUnreviewed Integer
  
  The number of test cases that have not yet been reviewed.
- totalSnapshotsRequestingChanges Integer
  
  The number of snapshots requesting changes.
functional Object

Functional scan summary for this run. Present only when functional scanning is enabled.

▶ SHOW VALUES
- status String
  
  The status of the functional scan. Possible values are completed or failed.
- ctaErrors Integer
  
  The number of CTA (call-to-action) errors found.
- brokenLinks Integer
  
  The number of broken links found.
- totalIssues Integer
  
  The total number of functional issues found.
- urlsWithIssues Integer
  
  The number of URLs that have at least one functional issue.
- totalUrlsScanned Integer
  
  The total number of URLs scanned for functional issues.
- webUrl String
  
  The URL to view the functional scan report in the BrowserStack dashboard. Present in scan run list responses only.
performance Object

Performance scan summary for this run. Present only when performance scanning is enabled.

▶ SHOW VALUES
- status String
  
  The status of the performance scan. Possible values are completed or failed.
- totalUrls Integer
  
  The total number of URLs scanned for performance.
- totalFailed Integer
  
  The number of URLs that failed performance scanning.
- testhubBuildUuid String
  
  The unique UUID of the performance test hub build.
- desktopRatingsCount Object
  
  Breakdown of desktop performance ratings across scanned URLs.
  
  ▶ SHOW VALUES
  - good Integer
    
    The number of URLs rated as good performance.
  - poor Integer
    
    The number of URLs rated as poor performance.
  - needs improvement Integer
    
    The number of URLs that need performance improvement.
- webUrl String
  
  The URL to view the performance report in the BrowserStack dashboard. Present in scan run list responses only.
responsive Object

Responsive design testing summary for this run. Present only when responsive testing is enabled.

▶ SHOW VALUES
- state String
  
  The processing state of the responsive testing build (for example, finished).
- status String
  
  The status of the responsive testing scan. Possible values are completed or failed.
- webUrl String
  
  The URL to view the responsive testing report.
- reviewState String
  
  The review state of the responsive testing build (for example, approved).
- totalSnapshots Integer
  
  The total number of responsive snapshots captured.
- totalTestCases Integer
  
  The total number of test cases for responsive testing.
- totalComparisons Integer
  
  The total number of responsive visual comparisons performed.
- reviewStateReason String
  
  The reason for the current review state.
- totalOpenComments Integer
  
  The number of open comments on this responsive testing build.
- totalComparisonsDiff Integer
  
  The number of comparisons that have visual differences.
- totalTestCasesFailed Integer
  
  The number of test cases that failed.
- totalComparisonsFinished Integer
  
  The number of comparisons that have finished processing.
- totalSnapshotsUnreviewed Integer
  
  The number of snapshots that have not yet been reviewed.
- totalTestCasesUnreviewed Integer
  
  The number of test cases that have not yet been reviewed.
- totalSnapshotsRequestingChanges Integer
  
  The number of snapshots requesting changes.

Did this page help you?

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.

We're continuously improving our docs. We'd love to know what you liked

This page has exactly what I am looking for
This content & code samples are accurate and up-to-date
The content on this page is easy to understand
Other (please tell us more below)

Any additional feedback?

Thank you for your valuable feedback

Get scan run summary API in Website Scanner

get scan run summary

Request parameters

proj_id* Integer

report_id* Integer

current_user_id String

product String

Response attributes 200 OK JSON

accessibility Object

score Integer

status String

pdfScan Object

pageCount Integer

issueCount Integer

buildStability Integer

componentCount Integer

percy Object

state String

status String

webUrl String

reviewState String

totalSnapshots Integer

totalTestCases Integer

totalComparisons Integer

reviewStateReason String

totalOpenComments Integer

totalComparisonsDiff Integer

totalTestCasesFailed Integer

totalSnapshotsRejected Integer

totalComparisonsFinished Integer

totalSnapshotsUnreviewed Integer

totalTestCasesUnreviewed Integer

totalSnapshotsRequestingChanges Integer

functional Object

status String

ctaErrors Integer

brokenLinks Integer

totalIssues Integer

urlsWithIssues Integer

totalUrlsScanned Integer

webUrl String

performance Object

status String

totalUrls Integer

totalFailed Integer

testhubBuildUuid String

desktopRatingsCount Object

good Integer

poor Integer

needs improvement Integer

webUrl String

responsive Object

state String

status String

webUrl String

reviewState String

totalSnapshots Integer

totalTestCases Integer

totalComparisons Integer

reviewStateReason String

totalOpenComments Integer

totalComparisonsDiff Integer

totalTestCasesFailed Integer

totalComparisonsFinished Integer

totalSnapshotsUnreviewed Integer

totalTestCasesUnreviewed Integer

totalSnapshotsRequestingChanges Integer

We're sorry to hear that. Please share your feedback so we can do better

We're continuously improving our docs. We'd love to know what you liked

proj_id^* Integer

report_id^* Integer

Response attributes `200 OK` `JSON`