Sign in

v1

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

Get List of Scans by Domain

Use this API to retrieve a list of scans for a specific domain and the specified filter criteria.

get/api/cmp/v1/webscans/domains/{domainId}/scans

Path parameters

domainIdstring uuid required

The unique identifier of the domain.

Query parameters

status'QUEUED' | 'PENDING' | 'INPROGRESS' | 'MIGRATION_STARTED' | 'MIGRATION_COMPLETED' | 'CATEGORIZATION_STARTED' | 'CATEGORIZATION_FAILED' | 'COMPLETED' | 'ERROR' | 'CANCELLED' | 'SCANNING' | 'DATA_MOVE' | 'RETRY_BY_AUTO_CORRECT' | 'MS_IOS_SCAN_SUCCESS' | 'MS_IOS_SCAN_FAILED' | 'MS_EXPORT_XLS_STARTED' | 'MS_EXPORT_PDF_STARTED'

The current state or condition of the item.

archiveStatus'NONE' | 'PENDING_UI' | 'PENDING_SCHEDULED' | 'ARCHIVE_STARTED' | 'ARCHIVE_COMPLETED' | 'ARCHIVE_QUEUED' | 'ERROR' | 'NO_DATA_TO_EXPORT'

The archival state of the scan.

startDatestring date

The beginning date for filtering or date range operations.

endDatestring date

The ending date for filtering or date range operations.

pageinteger
Example:1

The page number for pagination results, starting from 0.

sizeinteger
Example:10

The number of items to return per page.

Response

OK

totalPagesinteger

The total number of pages in the paginated results.

totalElementsinteger

The total number of items in the complete result set.

sizeinteger

The number of items to return per page.

numberinteger

The numeric value or identifier.

firstboolean

This flag indicates whether this is the first item in a sequence.

lastboolean

This flag indicates whether this is the last item in a sequence.

numberOfElementsinteger

The number of items in the current page.

emptyboolean

This flag indicates whether the result set is empty.

Example response

{
  "content": [
    {
      "scanId": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
      "domainId": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
      "startingUrl": "amazon.com",
      "sequence": 3,
      "crawlStartDt": "2025-04-01T12:34:32Z",
      "crawlEndDt": "2025-04-01T12:34:32Z",
      "usedQueryParameters": "language=en,region=on",
      "scanPageLimit": 1000,
      "pagesScanned": 155,
      "errorDescription": "ABRUPT_SCAN_TERMINATION",
      "cookieNotice": true,
      "totalPagesFound": 255,
      "cookiesFound": 132,
      "geoLocation": "northeurope",
      "status": "INPROGRESS",
      "scanType": "UI_SCAN",
      "archiveStatus": "ARCHIVE_COMPLETED"
    }
  ]
}