Skip to main content

ReadingBySeriesDto

Totals for one series, most-read first.

booksinteger<int64>required

Distinct books of the series read in the window.

duration objectrequired

Reading time split by how it was arrived at.

Deliberately two numbers rather than one. Time from the compatibility surfaces is reconstructed from the gaps between their writes: it undercounts and cannot see reading done from a downloaded book at all. Presenting a combined figure is fine; hiding that part of it is an estimate is not.

inferredMsinteger<int64>required

Milliseconds reconstructed server-side. An underestimate.

Example: 900000
measuredMsinteger<int64>required

Milliseconds reported by a client that measured its own reading.

Example: 5400000
totalMsinteger<int64>required

Convenience sum of the two, so clients do not each reimplement it.

Example: 6300000
pagesReadinteger<int64>required
seriesIdstring<uuid>required
seriesNamestringrequired
Example: Berserk
sessionsinteger<int64>required
ReadingBySeriesDto
{
"books": 0,
"duration": {
"inferredMs": 900000,
"measuredMs": 5400000,
"totalMs": 6300000
},
"pagesRead": 0,
"seriesId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"seriesName": "Berserk",
"sessions": 0
}