Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Scans

Get List of Websites

Use this API to retrieve a list of websites in the scanner. The response will return websites in Pending and Completed status for the organization and related child organizations.

get/api/cmp/v1/webscans

Query parameters

searchStrstring

The search term used to filter results.

externalOrgIdstring

The external organization identifier.

pageinteger
Example:1

The page number for pagination results, starting from 0.

sizeinteger
Example:10

The number of items to return per page.

sortBy'Url' | 'PagesScanned' | 'TotalCookieCount' | 'LastScannedDate' | 'ConsentPolicyName' | 'ScheduledNextScanDate' | 'MaxPagesScanned'

The field by which to sort the results.

direction'ASC' | 'DESC'

The sort order for results, either ascending or descending.

Response

OK

totalElementsinteger

The total number of items in the complete result set.

totalPagesinteger

The total number of pages in the paginated results.

pageSizeinteger

The number of items displayed per page.

pageNumberinteger

The current page number in the pagination sequence.

numberOfElementsinteger

The number of items in the current page.

Example response

{
  "content": [
    {
      "domainName": "amazon.com",
      "domainId": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
      "status": "SCANNING",
      "lastScannedDate": "2025-04-01T12:34:32Z",
      "lastScannedTotalCookies": 15,
      "uniqueCookiesFound": 10,
      "lastScannedTotalPages": 400,
      "maxPagesScanned": 123,
      "scheduledDateOfNextScan": "2025-04-01T12:34:32Z",
      "consentPolicyName": "as_georules",
      "scanError": "ABRUPT_SCAN_TERMINATION",
      "orgName": "org name",
      "externalOrgId": "orgnameid",
      "overPageLimit": true
    }
  ],
  "totalElements": 344,
  "totalPages": 35,
  "pageSize": 10,
  "pageNumber": 3,
  "numberOfElements": 115
}