No Result Found

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 https://api-accessibility.browserstack.com/api/website-scanner/v1/scans/{scan_id}/scan_runs/{scan_run_id}

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}

  • next_page String

    Used to fetch subsequent pages from the API when has_next parameter is true. Pass the next_page reference received in the response of last request.

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"
    "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"
    }
    }
}

  • scan_id Integer

    Unique ID of the scan.

  • scan_run_id Integer

    Unique ID of the scan run.

  • time String

    Timestamp of the scan run.

  • needsReview Boolean

    True if issues that require manual confirmation are included.

  • bestPractices Boolean

    True if best practices rules are included. These are not WCAG violations but are good to have to ensure accessibility.

  • Show 9 more

  • advanced Boolean

    True if reporting of issues in violation of advanced rules is enabled in the scan run.

  • wcagVersion String

    The WCAG version used for the analysis.

  • engineInfo Object

    Contains test engine info.

    ▶ SHOW VALUES

    • name String

      Name of the rules engine.

    • version String

      Version of the rules engine.

  • authEnabled Boolean

    True if authorization has been enabled for the scan run.

  • localTestingEnabled Boolean

    True if local testing has been enabled for the scan run.

  • status String

    The status of the report.

  • issueSummary Object

    Contains a summary of the accessibility issues found out in the scan.

    ▶ SHOW VALUES

    • componentCount Integer

      Number of components that have accessibility issues.

    • issueCount Integer

      Number of issues reported.

    • pageCount Integer

      Number of pages that have accessibility issues.

    • needsReview Integer

      Number of issues that require manual confirmation.

    • hidden Integer

      Number of issues that are hidden in the report.

  • issueCount Object

    Contains separate counts of issues according to various classifications.

    ▶ SHOW VALUES

    • issueCountBySeverity Object

      Separate counts of minor, serious, critical, and moderate issues.

      ▶ SHOW VALUES

      • minor Integer

        Number of minor issues.

      • serious Integer

        Number of serious issues.

      • critical Integer

        Number of critical issues.

      • moderate Integer

        Number of moderate issues.

    • issueCountByURL Object

      Separate counts of issues for each URL.

      ▶ SHOW VALUES

      • url String

        URL on which accessibility tests were performed.

      • count Integer

        Number of issues found on a specific URL.

    • issueCountByComponent Object

      Separate counts of issues for each component.

      ▶ SHOW VALUES

      • componentId String

        The component on which accessibility issues were found.

      • count Integer

        Number of issues found on a specific component.

    • issueCountByCategory Object

      Separate counts of issues for each component.

      ▶ SHOW VALUES

      • count Integer

        Number of issues found under a specific category.

      • category String

        A category under which issues were tracked.

  • pagination Object

    Contains information to facilitate fetching additional records if they exist.

    ▶ SHOW VALUES

    • has_next Boolean

      True if there are more records to fetch. False if the current response is the last page of records.

    • next_page String

      A reference to the next page. Pass this as a request parameter in the subsequent request as “next_page” to get the next page of records.

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





Thank you for your valuable feedback

Download Copy Check Circle