No Result Found

Get build report summary API in Automated Tests

Use this API to get a high-level summary of a build report from an automated test.

get build report summary

GET https://api-accessibility.browserstack.com/api/automated-tests/v1/builds/{thBuildId}

Request parameters

Request

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
https://api-accessibility.browserstack.com/api/automated-tests/v1/builds/{thBuildId}

  • 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

{
    "data": {
        "id": 117299,
        "buildNumber": 18544,
        "wcagVersion": "WCAG 2.1 AA",
        "testEngine": {
            "name": "a11y_engine",
            "version": "3.3.0"
        },
        "createdAt": "2024-12-15T13:08:27.943Z",
        "advanced": true,
        "needsReview": null,
        "bestPractice": null,
        "sessionData": {
            "browser": [
                {
                    "name": "chrome",
                    "version": "131.0.6778.70",
                    "logo": "chrome"
                }
            ],
            "os": [
                {
                    "name": "OS X",
                    "version": null,
                    "logo": "mac"
                }
            ],
            "framework": {
                "name": "Cucumber-Serenity",
                "version": "3.3.4"
            }
        },
        "healthSummary": {
            "failed": 1,
            "passed": 0,
            "skipped": 0,
            "total": 1
        },
        "issueSummary": {
            "issueCount": 76,
            "pageCount": 1,
            "componentCount": 12,
            "needsReview": 568,
            "hidden": 0
        },
        "issueCount": {
          "issueCountBySeverity": {
          "minor": 0,
          "serious": 708,
          "critical": 76,
          "moderate": 0
          },
          "issueCountByURL": [
            {
              "url": "https://www.samplesite.come/sampleurl",
              "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"
            }
        }
    }
}

  • id Integer

    Unique ID of the build run.

  • buildNumber Integer

    ID of the build.

  • wcagVersion String

    The WCAG version used for the analysis.

  • testEngine Object

    Contains test engine info.

    ▶ SHOW VALUES

    • name String

      Name of the rules engine.

    • version String

      Version of the rules engine.

  • createdAt String

    Timestamp of the build.

  • Show 8 more

  • advanced Boolean

    True if advanced rules are included.

  • 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.

  • sessionData Object

    Browser, OS, and framework details used for the build.

    ▶ SHOW VALUES

    • browser Object

      Details of the browser used for running the build.

      ▶ SHOW VALUES

      • name String

        Name of the browser used.

      • version String

        Version of the browser used.

      • logo String

        Brand name of the browser used.

    • os Object

      Details of the OS used for running the build.

      ▶ SHOW VALUES

      • name String

        Name of the OS used.

      • version String

        Version of the OS used.

      • logo Object

        Brand name of the OS used.

    • framework Object

      Details name of the testing framework used for running the build.

      ▶ SHOW VALUES

      • name String

        Name of the testing framework used for running the build.

      • version String

        Version of the testing framework used for running the build.

  • healthSummary Object

    Contains a split of the test statuses in the build.

    ▶ SHOW VALUES

    • failed Integer

      Number of tests that failed in the build.

    • success Integer

      Number of tests that ran successfully in the build.

    • skipped Integer

      Number of tests that were skipped in the build.

    • total Integer

      Total number of tests in the build.

  • issueSummary Object

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

    ▶ SHOW VALUES

    • issueCount Integer

      Number of issues reported.

    • pageCount Integer

      Number of pages that have accessibility issues.

    • componentCount Integer

      Number of components 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