No Result Found

Get scan run list API in Website Scanner

Use this API to get the list of scan runs for a given website scan.

get scan run list

GET https://api-accessibility.browserstack.com/api/website-scanner/v1/scans/{scan_id}/scan_runs

Request parameters

Request

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

  • 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

{
        scan_runs: [
        {
          "id": 292167,
          "scanDate": "2024-09-30T07:10:27.322Z",
          "issues": 784,
          "componentCount": 63,
          "reportSummary": {
            "failure": 1,
            "success": 0,
            "redirect": 54
          },
          "issueSummary": {
            "minor": 0,
            "serious": 708,
            "critical": 76,
            "moderate": 0
          },
          "error": null
      },
      {
        "id": 281194,
        "scanDate": "2024-09-23T06:30:24.281Z",
        "issues": 848,
        "componentCount": 67,
        "reportSummary": {
          "failure": 1,
          "success": 0,
          "redirect": 54
        },
        "issueSummary": {
          "minor": 0,
          "serious": 734,
          "critical": 114,
          "moderate": 0
        },
        "error": null
      },
      ...
      ],
    "pagination": {
      "has_next": true,
      "next_page": "eyJhbGciOiJIUzI1NiJ9.eyJwYWdlIjoxLCJwYWdlX3NpemUiOjEwLCJidWlsZF91dWlkIjoic3pkdGplMnhsaHNydWZkajF3bnJnYnZndnNmZzJjdGRsdWt4Nnl5eCIsImV4cCI6MTczNjY4NDA1OH0.sLI7hWQwE_bB6AB-ORgz1K6D2VIHqH_H39qK8Jh3HqA"
    }
}

  • id Integer

    Unique ID of the scan.

  • scanDate String

    Timestamp of the scan.

  • issues Integer

    The number of issues reported.

  • componentCount Integer

    The number of components with issues reported.

  • reportSummary Object

    Number of scans that failed, succeeded, or were redirected.

    ▶ 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.

  • issueSummary Object

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

    ▶ SHOW VALUES

    • componentCount Integer

      Number of components that have accessibility issues.

    • issueCount Integer

      Number of issues reported.

    • pageCount Integer

      Number of pages that have accessibility issues.

    • needsReview Integer

      Number of issues that require manual confirmation.

    • hidden Integer

      Number of issues that are hidden in the report.

  • error String

    Error information, if any.

  • 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