ReadProgressListResponse
Response containing a list of reading progress records
progress object[]required
List of progress records
Array [
bookIdstring<uuid>required
Book ID
Example:
550e8400-e29b-41d4-a716-446655440002completedbooleanrequired
Whether the book is completed
Example:
falsecompletedAtstring,null<date-time>nullable
When the book was completed (if completed)
Example:
2024-01-20T20:00:00ZcurrentPageinteger<int32>required
Current page (1-indexed)
Example:
42idstring<uuid>required
Progress record ID
Example:
550e8400-e29b-41d4-a716-446655440000progressPercentagenumber,null<double>nullable
Progress as a percentage (0.0-1.0) For EPUBs, this is the stored percentage from reflowable content For other formats, this is calculated from current_page / total_pages
Example:
0.45startedAtstring<date-time>required
When reading started
Example:
2024-01-10T14:30:00ZupdatedAtstring<date-time>required
When progress was last updated
Example:
2024-01-15T18:45:00ZuserIdstring<uuid>required
User ID
Example:
550e8400-e29b-41d4-a716-446655440001]
totalintegerrequired
Total count
Possible values: >= 0
Example:
25ReadProgressListResponse
{
"progress": [
{
"bookId": "550e8400-e29b-41d4-a716-446655440002",
"completed": false,
"completedAt": "2024-01-20T20:00:00Z",
"currentPage": 42,
"id": "550e8400-e29b-41d4-a716-446655440000",
"progressPercentage": 0.45,
"startedAt": "2024-01-10T14:30:00Z",
"updatedAt": "2024-01-15T18:45:00Z",
"userId": "550e8400-e29b-41d4-a716-446655440001"
}
],
"total": 25
}