No Result Found

Get scan run issues API in Website Scanner

Use this API to get issue details of a scan run report from Website Scanner.

get scan run issues

GET https://api-accessibility.browserstack.com/api/website-scanner/v1/scans/{scan_id}/scan_runs/issues?scan_run_id={scan_run_id}

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

Request

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
https://api-accessibility.browserstack.com/api/website-scanner/v1/scans/{scan_id}/scan_runs/issues?task_id={task_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,
    "engineInfo": {
            "name": "a11y_engine",
            "version": "2.6.0"
    },
    "wcagVersion": "WCAG 2.1 AA",
    "report_link": {CSV_file_link}
}

  • 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 5 more

  • advanced Boolean

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

  • engineInfo Object

    Contains test engine info.

    ▶ SHOW VALUES

    • name String

      Name of the rules engine.

    • version String

      Version of the rules engine.

  • wcagVersion String

    The WCAG version used for the scan run.

  • report_link String

    A hyperlink of the CSV file.

  • 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