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

Use this API to get a list of scans executed by the Website Scanner along with the basic details of these scans.

get scan list

GET /api/v1/scanner

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

  • current_user_id String

    Filter scans by a comma-separated list of user IDs.

  • team String

    Filter scans by a comma-separated list of team IDs.

  • page Integer

    Page number to retrieve. Default value is 1.

  • page_size Integer

    Number of scan configs to return per page. Default value is 30.

Response attributes 200 OK JSON

Response

{
    "scans": [
      {
        "id": 98036,
        "name": "Live Automated Profiling Report 1726553625",
        "createdBy": 8652120,
        "wcagVersion": "WCAG 2.1 AA",
        "recurring": true,
        "active": true,
        "nextScanDate": "2024-10-03T15:15:00.000Z",
        "status": "isProcessing",
        "advanced": true, 
        "localTestingEnabled": false, 
        "authEnabled": false,
        "cookieData": {
          "isCookieConfigured": true,
          "isCookieDeleted": false,
          "cookieConfigIds": [24]
        },
        "pageCount": 1,
        "scan_url": "Url to scan config",
        "lastScanDetails": {
                    "reportId": 256401,
                    "lastScanDate": "2024-08-28T06:30:00.000Z",
                    "scanStatus": "completed",
                    "issues": 1864,
                    "reportSummary": {
                        "failure": 0,
                        "success": 0,
                        "redirect": 397
                    },
                    "error": null
                },
      },
      {
        "id": 7180,
        ...
      },
      .
      .
    ],
    "pagination": {
      "has_next": true,
      "next_page": "eyJhbGciOiJIUzI1NiJ9.eyJwYWdlIjoxLCJwYWdlX3NpemUiOjEwLCJidWlsZF91dWlkIjoic3pkdGplMnhsaHNydWZkajF3bnJnYnZndnNmZzJjdGRsdWt4Nnl5eCIsImV4cCI6MTczNjY4NDA1OH0.sLI7hWQwE_bB6AB-ORgz1K6D2VIHqH_H39qK8Jh3HqA"
    }
 }

  • scans Array

    List of scan objects with basic details.

    â–¶ SHOW VALUES

    • id Integer

      The unique ID of the scan project.

    • name String

      The name of the scan project.

    • createdBy Integer

      The ID of the user who created the scan project.

    • wcagVersion String

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

    • recurring Boolean

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

    • active Boolean

      Whether the scan project is active.

    • nextScanDate String

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

    • status String

      The current processing status of the scan.

    • advanced Boolean

      Whether advanced accessibility scanning is enabled.

    • localTestingEnabled Boolean

      Whether BrowserStack Local testing is enabled for this scan project.

    • authEnabled Boolean

      Whether authentication 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.

    • pageCount Integer

      The number of URLs configured for scanning in the project.

    • scan_url String

      The URL to the scan configuration in the BrowserStack dashboard.

    • lastScanDetails Object

      Summary of the most recently completed scan run.

      â–¶ SHOW VALUES

      • reportId Integer

        The unique ID of the most recent scan run report.

      • lastScanDate String

        The ISO 8601 timestamp of the most recent scan run.

      • scanStatus String

        The status of the last scan run. Possible values are completed or failed.

      • issues Integer

        The total number of issues found in the last scan run.

      • reportSummary Object

        Page-level scan stability metrics for the last scan run.

        â–¶ SHOW VALUES

        • failure Integer

          The number of pages that failed to scan.

        • success Integer

          The number of pages that scanned successfully.

        • redirect Integer

          The number of pages that returned a redirect response.

      • error String

        Error message if the last scan failed. Returns null if no error occurred.

  • pagination Object

    Pagination details for the scan list.

    â–¶ SHOW VALUES

    • has_next Boolean

      Whether there are more pages of results available.

    • next_page String

      An encoded token to retrieve the next page of results. Use this value as the page query parameter in the next request.

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