Files
bookhoard/docs/developer/api/analytics/get_analytics.md
T
John O'Keefe 7a7b2ab82a docs(highlights,notes,opds,progress,analytics): Beam batch 9 — 13 endpoints
Highlights + notes CRUD (media-item scoped, jwt), progress delete,
reading-stats analytics, and the OPDS trio frontmatter'd. OPDS docs are
the first XML entries: example-response intentionally omitted (Atom
responses), gate contract honored via nil-Response registry pins.

Gate fix: group .Use() middleware now parsed (opds.Use(DeviceAuth...
Authenticate) previously resolved to auth 'none'). Registry: 13 entries.
Drift fixed by gate: reading-stats key names (total_reading_time_minutes,
most_active_day_of_week, daily_reading_minutes — draft invented
reading_time_hours/books_completed); notes/highlights list endpoints
return BARE arrays (no {notes:[]}/{highlights:[]} wrapper); create-note
request has no percentage_location/epubcfi_location. New
/tmp/merge_arrays.py handles array-example merges.

make test 9/9.
2026-10-24 17:47:07 -04:00

1.4 KiB

method, path, auth, area
method path auth area
GET /api/analytics/reading-stats jwt analytics

Get Reading Statistics

Retrieve reading statistics for a date range.

Endpoint: GET /api/analytics/reading-stats Auth: Required

Query Parameters

Parameter Type Required Description
start_date string No Start date (ISO 8601 format)
end_date string No End date (ISO 8601 format)

Request Headers

Header Type Required Description
Authorization string Yes Bearer token

Example Request

GET /api/analytics/reading-stats?start_date=2026-01-01&end_date=2026-01-31
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

Response (200 OK)

{
  "average_session_time_minutes": null,
  "completion_rate": null,
  "daily_reading_minutes": null,
  "longest_session_minutes": null,
  "most_active_day_of_week": null,
  "total_books_read": null,
  "total_pages_read": null,
  "total_reading_time_minutes": null
}

Error Responses

Code Description
400 Invalid date format
401 Invalid or expired token