Bookhoard/bookhoard
0
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 12 Wiki Activity

docs: add Carousel dashboard implementation plan

Browse Source
This commit is contained in:
john-okeefe
2026-02-17 17:00:46 -05:00
parent fce16b53f7
commit 96730d9475
407 changed files with 10834 additions and 10983 deletions
Download Patch File Download Diff File Expand all files Collapse all files
bruno/analytics/Get Device Usage.bru
-88
View File
@@ -1,88 +0,0 @@
meta {
name: Get Device Usage
type: http
seq: 2
}
get {
url: {{base_url}}/api/analytics/device-usage
body: none
auth: inherit
}
tests {
test("status must be 200", function() {
expect(res.status).to.eql(200);
});
test("response has devices array", function() {
const body = JSON.parse(res.body);
expect(body).to.have.property("devices");
expect(body.devices).to.be.an("array");
});
test("devices have required fields", function() {
const body = JSON.parse(res.body);
if (body.devices.length > 0) {
expect(body.devices[0]).to.have.property("device_name");
expect(body.devices[0]).to.have.property("device_type");
expect(body.devices[0]).to.have.property("sync_count");
}
});
}
settings {
encodeUrl: true
timeout: 0
}
docs {
Get usage statistics for all devices.
**Endpoint**: GET /api/analytics/device-usage
**Auth**: Required (Bearer token)
## Response Fields
| Field | Type | Description |
|-------|------|-------------|
| devices | array | List of device usage statistics |
| devices[].id | string | Device ID |
| devices[].device_name | string | Device name |
| devices[].device_type | string | Device type (kobo, kindle, koreader) |
| devices[].sync_count | int | Number of sync operations |
| devices[].last_sync | string | Last sync timestamp |
| devices[].total_reading_minutes | int | Total reading time on device |
| devices[].books_read | int | Number of books completed on device |
## Example Response
```json
{
"devices": [
{
"id": "789e4567-e89b-12d3-a456-426614174001",
"device_name": "My Kobo Clara",
"device_type": "kobo",
"sync_count": 45,
"last_sync": "2026-02-08T17:25:00Z",
"total_reading_minutes": 1250,
"books_read": 3
}
]
}
```
## Error Responses
| Code | Description |
|------|-------------|
| 401 | Unauthorized |
| 500 | Internal server error |
## Notes
- Only shows devices registered to the authenticated user
- Devices are sorted by sync_count in descending order
- Includes both active and inactive devices
}
bruno/analytics/Get Popular Books.bru
-99
View File
@@ -1,99 +0,0 @@
meta {
name: Get Popular Books
type: http
seq: 1
}
get {
url: {{base_url}}/api/analytics/popular-books?limit=10
body: none
auth: inherit
}
tests {
test("status must be 200", function() {
expect(res.status).to.eql(200);
});
test("response has books array", function() {
const body = JSON.parse(res.body);
expect(body).to.have.property("books");
expect(body.books).to.be.an("array");
});
test("books have required fields", function() {
const body = JSON.parse(res.body);
if (body.books.length > 0) {
expect(body.books[0]).to.have.property("title");
expect(body.books[0]).to.have.property("author");
expect(body.books[0]).to.have.property("read_count");
expect(body.books[0]).to.have.property("avg_completion");
}
});
}
settings {
encodeUrl: true
timeout: 0
}
docs {
Get popular books sorted by read count.
**Endpoint**: GET /api/analytics/popular-books
**Auth**: Required (Bearer token)
## Query Parameters
| Parameter | Type | Required | Description |
|-----------|------|-----------|-------------|
| limit | int | No | Maximum number of books to return (default: 10) |
## Response Fields
| Field | Type | Description |
|-------|------|-------------|
| books | array | List of popular books |
| books[].media_item_id | string | Book ID |
| books[].title | string | Book title |
| books[].author | string | Book author |
| books[].read_count | int | Number of times read |
| books[].avg_completion | float | Average completion rate (0-1) |
| books[].cover_url | string | Cover image URL |
## Example Request
```
GET /api/analytics/popular-books?limit=10
```
## Example Response
```json
{
"books": [
{
"media_item_id": "323e4567-e89b-12d3-a456-426614174002",
"title": "The Great Gatsby",
"author": "F. Scott Fitzgerald",
"read_count": 5,
"avg_completion": 0.85,
"cover_url": "/api/books/323e4567-e89b-12d3-a456-426614174002/cover"
}
]
}
```
## Error Responses
| Code | Description |
|------|-------------|
| 401 | Unauthorized |
| 500 | Internal server error |
## Notes
- Books are sorted by read_count in descending order
- Only books owned by the authenticated user are included
- avg_completion is calculated from all reading sessions
}
bruno/analytics/Get Reading Stats Date Range.bru
-95
View File
@@ -1,95 +0,0 @@
meta {
name: Get Reading Stats Date Range
type: http
seq: 3
}
get {
url: {{base_url}}/api/analytics/reading-stats?start_date=2024-01-01&end_date=2024-01-31
body: none
auth: inherit
}
tests {
test("status must be 200", function() {
expect(res.status).to.eql(200);
});
test("response has daily_reading_minutes array", function() {
const body = JSON.parse(res.body);
expect(body).to.have.property("daily_reading_minutes");
expect(body.daily_reading_minutes).to.be.an("array");
});
}
settings {
encodeUrl: true
timeout: 0
}
docs {
Get reading statistics for a specific date range.
**Endpoint**: GET /api/analytics/reading-stats
**Auth**: Required (Bearer token)
## Query Parameters
| Parameter | Type | Required | Description |
|-----------|------|-----------|-------------|
| start_date | string | No | Start date (ISO 8601 format, default: 30 days ago) |
| end_date | string | No | End date (ISO 8601 format, default: today) |
## Response Fields
| Field | Type | Description |
|-------|------|-------------|
| total_books_read | int | Total books completed in range |
| total_pages_read | int | Total pages read in range |
| total_reading_time_minutes | int | Total reading time in minutes |
| completion_rate | float | Percentage of books completed (0-1) |
| daily_reading_minutes | array | Daily reading time per day |
| daily_reading_minutes[].date | string | Date (ISO 8601) |
| daily_reading_minutes[].minutes | int | Minutes read on that date |
## Example Request
```
GET /api/analytics/reading-stats?start_date=2024-01-01&end_date=2024-01-31
```
## Example Response
```json
{
"total_books_read": 2,
"total_pages_read": 450,
"total_reading_time_minutes": 720,
"completion_rate": 0.85,
"daily_reading_minutes": [
{
"date": "2024-01-01",
"minutes": 30
},
{
"date": "2024-01-02",
"minutes": 45
}
]
}
```
## Error Responses
| Code | Description |
|------|-------------|
| 400 | Invalid date format |
| 401 | Unauthorized |
| 500 | Internal server error |
## Notes
- Dates must be in ISO 8601 format (YYYY-MM-DD)
- The range is inclusive of both start and end dates
- Daily data only includes days with reading activity > 0
}
bruno/analytics/Get Reading Stats.bru
-104
View File
@@ -1,104 +0,0 @@
meta {
name: Get Reading Stats
type: http
seq: 4
}
get {
url: {{base_url}}/api/analytics/reading-stats
body: none
auth: inherit
}
tests {
test("status must be 200", function() {
expect(res.status).to.eql(200);
});
test("response has required stats fields", function() {
const body = JSON.parse(res.body);
expect(body).to.have.property("total_books_read");
expect(body).to.have.property("total_pages_read");
expect(body).to.have.property("total_reading_time_minutes");
expect(body).to.have.property("completion_rate");
expect(body).to.have.property("daily_reading_minutes");
});
test("daily_reading_minutes is an array", function() {
const body = JSON.parse(res.body);
expect(body.daily_reading_minutes).to.be.an("array");
});
}
settings {
encodeUrl: true
timeout: 0
}
docs {
Get overall reading statistics for the authenticated user.
**Endpoint**: GET /api/analytics/reading-stats
**Auth**: Required (Bearer token)
## Query Parameters
| Parameter | Type | Required | Description |
|-----------|------|-----------|-------------|
| start_date | string | No | Start date (ISO 8601 format) |
| end_date | string | No | End date (ISO 8601 format) |
## Response Fields
| Field | Type | Description |
|-------|------|-------------|
| total_books_read | int | Total books completed |
| total_pages_read | int | Total pages read |
| total_reading_time_minutes | int | Total reading time in minutes |
| completion_rate | float | Average book completion rate (0-1) |
| daily_reading_minutes | array | Daily reading time breakdown |
| daily_reading_minutes[].date | string | Date (ISO 8601) |
| daily_reading_minutes[].minutes | int | Minutes read on that date |
## Example Request
```
GET /api/analytics/reading-stats
```
## Example Response
```json
{
"total_books_read": 12,
"total_pages_read": 3450,
"total_reading_time_minutes": 5400,
"completion_rate": 0.78,
"daily_reading_minutes": [
{
"date": "2026-01-15",
"minutes": 45
},
{
"date": "2026-01-16",
"minutes": 60
}
]
}
```
## Error Responses
| Code | Description |
|------|-------------|
| 400 | Invalid date format |
| 401 | Unauthorized |
| 500 | Internal server error |
## Notes
- Without date parameters, returns stats for the last 30 days
- Dates must be in ISO 8601 format (YYYY-MM-DD) when provided
- Only includes reading activity from the authenticated user
- Daily data includes all days with reading activity
}