No Result Found

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 https://api-accessibility.browserstack.com/api/website-scanner/v1/scans

Request parameters

Request

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
https://api-accessibility.browserstack.com/api/website-scanner/v1/scans

  • next_page String

    Used to fetch subsequent pages from the API when has_next parameter is true. Pass the next_page reference received in the response of last request.

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
        "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"
    }
 }

  • id Integer

    Unique ID of the scan.

  • name String

    Name of the scan.

  • createdBy Integer

    Specifies the ID of the scan creator.

  • wcagVersion String

    The WCAG version used for the analysis.

  • recurring Boolean

    True if the scan is a recurring one.

  • Show 10 more

  • active Boolean

    True if the scan is active.

  • nextScanDate String

    Timestamp of the next scheduled scan.

  • status String

    The status of the scan.

  • advanced Boolean

    True if reporting of issues in violation of advanced rules is enabled.

  • localTestingEnabled Boolean

    True if local testing is enabled in the scan.

  • authEnabled Boolean

    True if authorization is enabled in the scan.

  • pageCount Integer

    Number of pages in the scan.

  • scan_url String

    URL to scan config.

  • lastScanDetails Object

    Contains a summary of the accessibility issues found out in the scan.

    ▶ SHOW VALUES

    • reportId Integer

      Unique ID of the report.

    • lastScanDate String

      Timestamp of the last scan.

    • scanStatus String

      The status of the scan.

    • issues Integer

      Number of issues identified in the scan.

    • reportSummary Object

      A summary of the previous scan in terms of how many were failure, success, or redirect.

      ▶ SHOW VALUES

      • failure Integer

        Number of URLs that failed to get scanned.

      • success Integer

        Number of URLs that were successfully scanned.

      • redirect Integer

        Number of URLs that were redirected.

  • pagination Object

    Contains information to facilitate fetching additional records if they exist.

    ▶ SHOW VALUES

    • has_next Boolean

      True if there are more records to fetch. False if the current response is the last page of records.

    • next_page String

      A reference to the next page. Pass this as a request parameter in the subsequent request as “next_page” to get the next page of records.

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