Skip to main content
AI agents are now live in Website Scanner! Enter your URL and fix website issues 3x faster with AI. Explore now!
No Result Found
Get your setup working faster. Join our Discord for optimisation tips from elite testers. Join our DiscordJoin our Discord

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 /api/website-scanner/v1/scans/{scan_id}/scan_runs/issues?scan_run_id={scan_run_id}

GET /api/website-scanner/v1/scans/{scan_id}/scan_runs/issues?task_id={task_id}

If Geo Region Restriction (GRR) is enabled for your account, add your region code to the host name: api-accessibility-<region>.browserstack.com. See Geo Region Restriction endpoints for the region codes and examples.

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}
  • scan_id* Integer

    The unique ID of the scan.

  • scan_run_id Integer

    The unique ID of the scan run. Use this or task_id to identify the scan run.

  • task_id Integer

    The unique task ID for the scan run. Use this or scan_run_id to identify the scan run.

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": "https://api-accessibility.browserstack.com/reports/scan_run_292167.csv"
}
  • scan_id Integer

    The unique ID of the scan project.

  • scan_run_id Integer

    The unique ID of the scan run.

  • time String

    The ISO 8601 timestamp of the scan run.

  • needsReview Boolean

    Whether issues that need review were included in the scan.

  • bestPractices Boolean

    Whether best practice violations were included in the scan.

  • advanced Boolean

    Whether advanced accessibility checks were enabled.

  • engineInfo Object

    Details of the accessibility test engine used for the scan.

    â–¶ SHOW VALUES
    • name String

      The name of the test engine used for accessibility scanning (for example, a11y_engine).

    • version String

      The version of the test engine.

  • wcagVersion String

    The WCAG version used for the scan (for example, WCAG 2.1 AA).

  • report_link String

    The URL to download the scan run issues as a CSV file.

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