Skip to main content

ExportReadingProgressQuery

Query parameters for GET /api/v1/reading-progress/export.

includeSessionsboolean

Sessions are opt-out: they are the only source of every reading statistic, so leaving them out is easy to do by accident and hard to notice until the numbers are gone.

libraryIdsstring | nullnullable

Comma-separated library ids to export, e.g. ?libraryIds=<uuid>,<uuid>. Omitted exports every library the reader has state for.

Comma-separated rather than a repeated key because axum's Query extractor deserializes with serde_urlencoded, which collapses a repeated key instead of collecting it into a Vec.

ExportReadingProgressQuery
{
"includeSessions": true,
"libraryIds": "string"
}