No Result Found

Get report list API in Workflow Analyzer

Use this API to get a list of reports along with the basic details of these reports.

get report list

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

Request parameters

Request

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

  • 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

{
    "reports": [
      {
        "id": 30648,
        "name": "Sample Analysis",
        "createdBy": {
          "user_id": 6456742,
          "name": "John Doe"
        },
        "wcagVersion": "WCAG 2.1 AA",
        "status": "completed",
        "needsReview": true,
        "bestPractices": false,
        "advanced": true,
        "scanType": "Full page",
        "engineInfo": {
            "testEngine": {
                "name": "a11y_engine",
                "version": "3.3.0"
            }
        },
        "issueSummary": {
            "componentCount": 11,
            "issueCount": 14,
            "pageCount": 2
        }
      },
      {
        "id": 7180,
        ...
      },
      .
      .
    ],
    "pagination": {
      "has_next": true,
      "next_page": "eyJhbGciOiJIUzI1NiJ9.eyJwYWdlIjoxLCJwYWdlX3NpemUiOjEwLCJidWlsZF91dWlkIjoic3pkdGplMnhsaHNydWZkajF3bnJnYnZndnNmZzJjdGRsdWt4Nnl5eCIsImV4cCI6MTczNjY4NDA1OH0.sLI7hWQwE_bB6AB-ORgz1K6D2VIHqH_H39qK8Jh3HqA"
    }
 }

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

  • wcagVersion String

    The WCAG version used for the analysis.

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

  • Show 7 more

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

  • 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