Skip to main content

OrphanedHistoryDto

The caller's reading history whose book has since been deleted, across every date. What a purge would remove.

completionsinteger<int64>required

Finished read-throughs.

Possible values: >= 0

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
sessionsinteger<int64>required

Sittings, counted as the dashboard counts them.

OrphanedHistoryDto
{
"completions": 0,
"duration": {
"inferredMs": 900000,
"measuredMs": 5400000,
"totalMs": 6300000
},
"pagesRead": 0,
"sessions": 0
}