No Result Found

Get report summary API in Workflow Analyzer

Use this API to get a high-level summary of a report from a Workflow analyzer.

get report summary

GET https://api-accessibility.browserstack.com/api/workflow-analyzer/v1/reports/{report_id}

Request parameters

Request

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
https://api-accessibility.browserstack.com/api/workflow-analyzer/v1/reports/{report_id}

Response Attributes 200 OK JSON

Response

{
  "id": 30648,
  "name": "Sample Test",
  "createdBy": {
    "id": 6456742,
    "name": "John Doe"
  },
  "time": "2024-09-30T06:30:00.000Z",
  "wcagVersion": "WCAG 2.1 AA",
  "status": "completed",
  "needsReview": null,
  "bestPractices": null,
  "advanced": true,
  "scanType": "Full page",
  "engineInfo": {
    "testEngine": {
      "name": "a11y_engine",
      "version": "3.3.0"
    }
  },
  "issueSummary": {
    "componentCount": 1,
    "issueCount": 2,
    "pageCount": 1,
    "needsReview": 568,
    "hidden": 0
  },
  "issueCount": {
    "issueCountBySeverity": {
      "minor": 0,
      "serious": 708,
      "critical": 76,
      "moderate": 0
    },
    "issueCountByURL": [
      {
        "url": "https://www.browserstack.com",
        "count": 58
      },
      {
        ...
      },
      ...
    ],
    "issueCountByComponent": [
      {
        "componentId": "A#main-nav__link",
        "count": 174
      },
      {
        ...
      },
      ...
    ],
    "issueCountByCategory": [
      {
        "count": 0,
        "category": "keyboard"
      },
      {
        ...
      },
      ...
    ]
  }
}

  • id Integer

    Unique ID of the report.

  • name String

    Name of the report.

  • createdBy Object

    Specifies the ID and name of the creator of the report.

    ▶ SHOW VALUES

    • id Integer

      ID of the report creator.

    • name String

      Name of the report creator.

  • time String

    Timestamp of the report.

  • wcagVersion String

    The WCAG version used for the analysis.

  • Show 8 more

  • status String

    The status of the report. “Finalizing” means that advanced rules are being evaluated and issues are still being processed. “Completed” means the complete report has been generated.

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

  • advanced Boolean

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

  • scanType String

    Indicates whether the scope of the scan was the entire page or part of the page.

  • engineInfo Object

    Contains test engine info.

    ▶ SHOW VALUES

    • testEngine Object

      Name and version of the rule engine used.

      ▶ SHOW VALUES

      • name String

        Name of the rules engine.

      • version String

        Version of the rules engine.

  • issueSummary Object

    Contains a summary of the accessibility issues found during 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.

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