Skip to main content

RecommendationDto

A single recommendation for the user

basedOnstring[]

Titles that influenced this recommendation

codexSeriesIdstring | nullnullable

Codex series ID if matched to an existing series

coverUrlstring | nullnullable

Cover image URL

externalIdstringrequired

External ID on the source service

externalUrlstring | nullnullable

URL to the entry on the external service

genresstring[]

Genres

inCodexboolean

Whether this series exists in the Codex library (matched via external IDs)

inLibraryboolean

Whether this series is already in the user's library (as reported by the plugin)

popularityinteger,null<int32>nullable

Popularity ranking/count on the source service

ratinginteger,null<int32>nullable

Average user rating on the source service (0-100 scale)

reasonstringrequired

Human-readable reason for this recommendation

scorenumber<double>required

Confidence/relevance score (0.0 to 1.0)

statusstring | nullnullable

Publication status (ongoing, ended, hiatus, abandoned, unknown)

summarystring | nullnullable

Summary/description

titlestringrequired

Title of the recommended series/book

totalBookCountinteger,null<int32>nullable

Total expected number of books/volumes in the series

RecommendationDto
{
  "basedOn": [
    "string"
  ],
  "codexSeriesId": "string",
  "coverUrl": "string",
  "externalId": "string",
  "externalUrl": "string",
  "genres": [
    "string"
  ],
  "inCodex": true,
  "inLibrary": true,
  "popularity": 0,
  "rating": 0,
  "reason": "string",
  "score": 0,
  "status": "string",
  "summary": "string",
  "title": "string",
  "totalBookCount": 0
}