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 status API in Website Scanner

Use this API to to check the status of a scan run.

get scan run status

GET /api/v1/scanner/{proj_id}/scan_builds/{report_id}/status

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/{scan_run_id}/status

  • proj_id* Integer

    The unique ID of the scan project.

  • report_id* Integer

    The unique ID of the scan run report.

  • current_user_id String

    The user ID of the current user making the request.

Response Attributes 200 OK JSON

Response

{
  "success": true,
  "data":{
    "scan_id": 1234,
    "scan_run_id": 5678,
    "status": "completed"
  },
  "error": null
}

  • success Boolean

    Indicates whether the request was successful.

  • status String

    The current status of the scan run. Possible values are queued, processing, finalizing, completed, or failed.

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