Get scan run list API in Website Scanner

Use this API to get the list of scan runs for a given website scan.

get scan run list

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

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

proj_id^* Integer

The unique ID of the scan project.
page Integer

Page number to retrieve. Default value is 1.
page_size Integer

Number of scan runs to return per page. Default value is 30.

Response attributes `200 OK` `JSON`

Response

{
        scan_runs: [
        {
          "id": 292167,
          "scanDate": "2024-09-30T07:10:27.322Z",
          "issues": 784,
          "componentCount": 63,
          "reportSummary": {
            "failure": 1,
            "success": 0,
            "redirect": 54
          },
          "issueSummary": {
            "minor": 0,
            "serious": 708,
            "critical": 76,
            "moderate": 0
          },
          "error": null
      },
      {
        "id": 281194,
        "scanDate": "2024-09-23T06:30:24.281Z",
        "issues": 848,
        "componentCount": 67,
        "reportSummary": {
          "failure": 1,
          "success": 0,
          "redirect": 54
        },
        "issueSummary": {
          "minor": 0,
          "serious": 734,
          "critical": 114,
          "moderate": 0
        },
        "error": null
      },
      ...
      ],
    "pagination": {
      "has_next": true,
      "next_page": "eyJhbGciOiJIUzI1NiJ9.eyJwYWdlIjoxLCJwYWdlX3NpemUiOjEwLCJidWlsZF91dWlkIjoic3pkdGplMnhsaHNydWZkajF3bnJnYnZndnNmZzJjdGRsdWt4Nnl5eCIsImV4cCI6MTczNjY4NDA1OH0.sLI7hWQwE_bB6AB-ORgz1K6D2VIHqH_H39qK8Jh3HqA"
    }
}

success Boolean

Indicates whether the request was successful.
info Object

Pagination metadata for the list of scan runs.

▶ SHOW VALUES
- page Integer
  
  The current page number.
- pageSize Integer
  
  The number of items per page.
- count Integer
  
  The total number of results returned on the current page.
- prev Integer
  
  The previous page number. Returns null if there is no previous page.
- next Integer
  
  The next page number. Returns null if there is no next page.
builds Array

An array of scan run objects, each containing per-product summaries.

▶ SHOW VALUES
- id Integer
  
  The unique internal ID of the scan run.
- reportId Integer
  
  The unique report ID for this scan run, used to retrieve detailed reports.
- buildNumber Integer
  
  The sequential build number of this scan run within the project.
- name String
  
  The name of the scan project associated with this run.
- createdAt String
  
  The ISO 8601 timestamp when the scan run was created.
- startedAt String
  
  The ISO 8601 timestamp when the scan run started executing.
- productsEnabled Array
  
  List of BrowserStack products enabled for this scan run (for example, a11y, percy, functional, performance, responsive, content_checker, form_checker).
- pageCount Integer
  
  The number of pages scanned in this run.
- createdBy Object
  
  Information about the user who triggered this scan run.
  
  ▶ SHOW VALUES
  - id Integer
    
    The unique ID of the user.
  - name String
    
    The display name of the user.
- projectId Integer
  
  The ID of the scan project this run belongs to.
- thBuildUuid String
  
  The unique UUID for this build in the BrowserStack test hub.
- prodBuild Boolean
  
  Whether this is a production build.
- error String
  
  Error message if a page was not reachable during the scan. Returns null if no error occurred.
- summary Object
  
  A summary of the scan run status and per-product results.
  
  ▶ SHOW VALUES
  - status String
    
    The overall status of the scan run. Possible values are completed or failed.
  - accessibility Object
    
    Accessibility-specific summary for this scan run.
    
    ▶ SHOW VALUES
    - score Integer
      
      The accessibility score for this scan run (0–100).
    - status String
      
      The status of the accessibility scan for this run. Possible values are completed or failed.
    - pageCount Integer
      
      The number of pages for which the accessibility scan completed.
    - issueCount Integer
      
      The total number of accessibility issues found in this run.
    - scanStability Object
      
      Page-level scan stability metrics for this run.
      
      ▶ SHOW VALUES
      - total Integer
        
        The total number of pages in the scan.
      - failure Integer
        
        The number of pages that failed to scan.
      - success Integer
        
        The number of pages that scanned successfully.
      - redirect Integer
        
        The number of pages that returned a redirect response.
    - buildStability Integer
      
      The number of pages that were successfully scanned for accessibility in this run.
    - componentCount Integer
      
      The number of UI components affected by accessibility issues in this run.
    - webUrl String
      
      The URL to view the accessibility report for this run in the BrowserStack dashboard.
    - browser String
      
      The browser used for accessibility scanning in this run (for example, chrome).
  - percy Object
    
    Visual testing (Percy) summary for this scan run. Present only when Percy is enabled.
    
    ▶ 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 scan 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 scan 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.
  - contentChecker Object
    
    Content checker summary for this scan run. Present only when content checking is enabled.
    
    ▶ SHOW VALUES
    - status String
      
      The status of the content checker scan. Possible values are completed or failed.
    - totalUrls Integer
      
      The total number of URLs scanned for content issues.
    - totalIssues Integer
      
      The total number of content issues found (spelling and grammar combined).
    - urlsWithAnyIssues Integer
      
      The number of URLs that have at least one content issue.
    - totalGrammarIssues Integer
      
      The total number of grammar issues found.
    - totalSpellingIssues Integer
      
      The total number of spelling issues found.
    - webUrl String
      
      The URL to view the content checker report in the BrowserStack dashboard.
  - formChecker Object
    
    Form checker summary for this scan run. Present only when form checking is enabled.
    
    ▶ SHOW VALUES
    - status String
      
      The status of the form checker scan. Possible values are completed or failed.
    - totalForms Integer
      
      The total number of forms found across all scanned pages.
    - formsFailed Integer
      
      The number of forms that have issues.
    - urlsWithForms Integer
      
      The number of URLs that contain forms.
    - formsSuccessful Integer
      
      The number of forms that passed all checks.
    - formsWithIssues Integer
      
      The number of forms with at least one issue.
    - totalUrlsScanned Integer
      
      The total number of URLs scanned for form issues.
    - formsWithOpenIssues Integer
      
      The number of forms with open (unresolved) issues.
    - formsWithSubmissionIssues Integer
      
      The number of forms with submission-related issues.
    - webUrl String
      
      The URL to view the form checker report in the BrowserStack dashboard.
  - responsive Object
    
    Responsive design testing summary for this scan 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.
  - scanStability Object
    
    Page-level scan stability metrics for this run.
    
    ▶ SHOW VALUES
    - total Integer
      
      The total number of pages in the scan.
    - failure Integer
      
      The number of pages that failed to scan.
    - success Integer
      
      The number of pages that scanned successfully.
    - redirect Integer
      
      The number of pages that returned a redirect response.

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 list API in Website Scanner

get scan run list

Request parameters

proj_id* Integer

page Integer

page_size Integer

Response attributes 200 OK JSON

success Boolean

info Object

page Integer

pageSize Integer

count Integer

prev Integer

next Integer

builds Array

id Integer

reportId Integer

buildNumber Integer

name String

createdAt String

startedAt String

productsEnabled Array

pageCount Integer

createdBy Object

id Integer

name String

projectId Integer

thBuildUuid String

prodBuild Boolean

error String

summary Object

status String

accessibility Object

score Integer

status String

pageCount Integer

issueCount Integer

scanStability Object

total Integer

failure Integer

success Integer

redirect Integer

buildStability Integer

componentCount Integer

webUrl String

browser String

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

proj_id^* Integer

Response attributes `200 OK` `JSON`