Get reading days
get_reading_daysLists the page the reader reached on each day of one reading of a book in their ReadingRate library: for each day, the furthest page, the page they left off at, the pages read and the percent of their copy.
Use when the user asks how far they got each day, how many pages they read on which days, how long a book took them day by day, or wants a chart of their progress through a book. For the books themselves, their status and dates, use get_reading_history.
ReadingRate records each change of page from the time this history began, so days before logged_since are unknown, not unread. Days are counted in timezone: give the reader's IANA time zone when known (for example "Europe/London"); otherwise their notification setting is used, else UTC.
Examples:
{"book_id": ""}
{"book_id": "", "timezone": "Europe/London"}
{"book_id": "", "reading_number": 1}
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| book_id | Yes | The book's ReadingRate id or its library entry id | |
| timezone | No | IANA time zone the days are counted in, for example "Europe/London" | |
| reading_number | No | Which reading: 1 for the first, 2 for a reread. Default: the latest |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| book | Yes | The book: id, slug, title, authors | |
| days | Yes | One entry per day with a page change, oldest first | |
| note | No | What the days do and do not cover | |
| status | No | read | reading | want_to_read | stopped | dnf | |
| end_date | No | ||
| timezone | No | The time zone the days are counted in | |
| start_date | No | ||
| total_pages | No | Printed pages in the reader's copy, without a roman-numbered introduction; percent counts the whole copy | |
| current_page | No | ||
| logged_since | No | When the first page change of this reading was recorded; days before it are not known | |
| reading_number | No | Which reading of the book: 1 for the first, 2 for a reread | |
| reverse_numbering | No | The book counts down to page 1: its furthest page each day is the lowest | |
| current_page_label | No | current_page as the book prints it, e.g. "liv" or "10" | |
| front_matter_pages | No | Roman-numbered pages at the front of the reader's copy (an introduction numbered i–lx is 60). When set, every page here counts from page i, and the *_label fields give the page as printed |