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

Use this API to get a high-level summary of a website scan.

get scan details

GET /api/v1/scanner/{proj_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}/overview

  • proj_id* Integer

    The unique ID of the scan project.

  • current_user_id String

    The user ID of the current user making the request.

Response attributes 200 OK JSON

Response

"data": {
    "scanConfigInfo": {
      "name": "Browserstack demo",
      "scanConfigId": 1199,
      "createdBy": {
        "id": 6456742,
        "name": "John Doe"
      },
      "wcagVersion": "WCAG 2.1 AA",
      "needsReview": true,
      "bestPractices": false,
      "recurring": true,
      "advanced": false,
      "pageCount": 3,
      "nextScanDate": "2024-10-03T06:30:00.000Z",
      "active": true,
      "isProcessing": false,
      "authEnabled": false,
      "localTestingEnabled": false,
      "cookieData": {
        "isCookieConfigured": true,
        "isCookieDeleted": false,
        "cookieConfigIds": [24]
      }
    },
    "urlList": [
        "https://sample1.com",
        "https://sample2.com",
        "https://sample3.com"
      ]
}

  • data Object

    Contains the scan configuration details and URL list.

    â–¶ SHOW VALUES

    • scanConfigInfo Object

      The scan configuration details including name, schedule, and accessibility settings.

      â–¶ SHOW VALUES

      • name String

        The name of the scan project.

      • scanConfigId Integer

        The unique ID of the scan configuration.

      • createdBy Object

        Information about the user who created the scan project.

        â–¶ SHOW VALUES

        • id Integer

          The unique ID of the user.

        • name String

          The display name of the user.

      • wcagVersion String

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

      • needsReview Boolean

        Whether issues that need review are included in the scan results.

      • bestPractices Boolean

        Whether best practice violations are included in the scan results.

      • recurring Boolean

        Whether the scan is scheduled to run on a recurring basis.

      • advanced Boolean

        Whether advanced accessibility checks are enabled.

      • pageCount Integer

        The number of URLs configured for scanning.

      • nextScanDate String

        The ISO 8601 timestamp of the next scheduled scan run. Returns null for non-recurring scans.

      • active Boolean

        Whether the scan project is active.

      • isProcessing Boolean

        Whether a scan run is currently in progress.

      • authEnabled Boolean

        Whether authentication is enabled for this scan project.

      • localTestingEnabled Boolean

        Whether BrowserStack Local testing is enabled for this scan project.

      • cookieData Object

        Cookie configuration status for this scan project.

        â–¶ SHOW VALUES

        • isCookieConfigured Boolean

          Whether a cookie configuration is set for the scan project.

        • isCookieDeleted Boolean

          Whether a linked cookie configuration has been deleted. The scan keeps running with the last known cookie values.

        • cookieConfigIds Array

          The IDs of the linked cookie configurations. Returns an empty array if none are set.

    • urlList Array

      The list of URLs configured for scanning.

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