ScanStatusDto

Scan status response

booksFoundinteger | nullnullable

Number of books created plus updated by this scan. Books that were deleted or restored are tracked separately and are not counted here, so a re-scan that changed nothing reports zero rather than the size of the library.

Possible values: >= 0

Example: 750

completedAt(string | null)<date-time>nullable

When the scan completed (if finished)

Example: 2024-01-15T10:45:00Z

errorsstring[]required

Errors encountered during the scan, plus the task's fatal error if it had one. Capped at the first 100 individual errors; a scan that produced more is truncated here rather than in the count the worker records.

filesProcessedinteger | nullnullable

Number of files processed so far.

Possible values: >= 0

Example: 750

filesTotalinteger | nullnullable

Total number of files the scan discovered, which is the denominator filesProcessed counts towards. null until file discovery finishes.

Possible values: >= 0

Example: 1500

libraryIdstring<uuid>required

Library ID being scanned

Example: 550e8400-e29b-41d4-a716-446655440000

seriesFoundinteger | nullnullable

Number of series created by this scan. A re-scan that matched only existing series reports zero.

Possible values: >= 0

Example: 45

startedAtstring<date-time>required

When the scan started

Example: 2024-01-15T10:30:00Z

statusstringrequired

Current status of the scan (scanning, completed, failed).

The counts below are null when they are not known, which is different from zero: a scan that genuinely found nothing reports 0, while one that has not recorded anything yet reports null.

Example: scanning

ScanStatusDto

{
  "booksFound": 750,
  "completedAt": "2024-01-15T10:45:00Z",
  "errors": [
    "string"
  ],
  "filesProcessed": 750,
  "filesTotal": 1500,
  "libraryId": "550e8400-e29b-41d4-a716-446655440000",
  "seriesFound": 45,
  "startedAt": "2024-01-15T10:30:00Z",
  "status": "scanning"
}