Files
bookhoard/docs/developer/api/analytics/get_device_usage.md
T
John O'Keefe 6fc501b35a docs(stats): Claude-side pinning — all 4 stats endpoints + UNVERIFIED sweep to zero
Stats docs written handler/service-first (summary/this-week/book-stats
new; library-usage frontmatter'd — its body was already accurate).
Registry: 4 entries on services.UserSummaryStats/WeekSummaryStats/
LibraryUsageStats/BookStats. Family-lens note: library-usage 403s an
explicit library_id outside the visible set (431fec0 rule).

UNVERIFIED sweep (7 -> 0), each resolved against the handler:
- device-usage takes NO date params; popular-books takes only ?limit
  (the 'standard analytics date-range params' claim was wrong)
- link_book media_item_id: no validate tag but service-always-written
- push_stats book-ref field set documented (uuid/sha256/title/authors)
- filter_count: confirmed ParseMediaSearchParams machinery + 400 on bad
  filter + 403 visibility
- facets values element shape pinned: {value, display?, count}
- get_config: dynamic key set IS the contract (reworded, no marker)

make test 9/9.
2026-10-24 18:25:12 -04:00

41 lines
836 B
Markdown

---
method: GET
path: /api/analytics/device-usage
auth: jwt
area: analytics
---
<!-- source: internal/handlers/analytics.go DeviceUsageResponse / GetDeviceUsage -->
# Get Device Usage
Per-device sync activity for the signed-in user.
## Example response
```json example-response
{
"devices": [
{
"device_id": "550e8400-e29b-41d4-a716-446655440000",
"device_name": "Kobo Clara",
"device_type": "kobo",
"sync_count": 42,
"last_sync": "2026-10-24T13:57:01Z",
"total_time_seconds": 3600,
"total_time_minutes": 60
}
]
}
```
## Query parameters
None. The handler aggregates the user's full device-usage history — there
is no date-range filtering on this endpoint.
## Errors
| Status | Body | When |
| ------ | ---- | ---- |
| 500 | `{"error": "..."}` | unexpected server error |