No Result Found

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 https://api-accessibility.browserstack.com/api/website-scanner/v1/scans/{scan_id}/scan_runs/{scan_run_id}/status

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

  • No parameter required.

Response Attributes 200 OK JSON

Response

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

  • success Boolean

    True, if the status of the scan run is obtained.

  • data Object

    Fields returned to detail the status of the scan run.

    ▶ SHOW VALUES

    • scan_id Integer

      A unique id for the scan.

    • scan_run_id Integer

      A unique id for a specific scan run.

    • scan_run_status String

      The status of the scan run, which can be one among “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