Watch statistics: For developers
How Watch statistics is built, for anyone who wants to change it or make one like it. It is MIT, by TheMightyTRexUK, and works with plug-in API >=1.14 <2.0.
Its files
starboard-plugin.jsonapp.pysbplugin.pyDockerfileinstall.pylogo.svgCHANGELOG.mdtests/test_watch_stats.py
Containers
| Container | Network | Folders | Runs as | Starts | Limits |
|---|---|---|---|---|---|
main |
lan |
data |
10001:10001 |
when_needed |
64 MB, 0.25 core |
Each image is pinned by digest in the manifest:
main:ghcr.io/themightytrex/starboard-plugin-examples@sha256:83b980f1828cdee537bcdf03702ddf6458710cba53f9009938225df430d34d9e
What Starboard calls
| Path | What it is |
|---|---|
GET /health |
Health: 200 while it can work |
GET /card/week |
The Plays this week card (stat) |
GET /card/top |
The Top titles card (list) |
GET /card/people |
The Who watched most card (list) |
GET /card/source |
The Watch statistics source card (status) |
POST /refresh |
The Check now button |
GET /screen/plays |
The Recent plays page |
GET /screen/titles |
The Top titles page |
GET /screen/people |
The People page |
POST /update/before |
The update's before step, 60 seconds at most |
POST /update/after |
The update's after step, 10 seconds at most |
How it works
app.pyasks Jellyfin for its plug-ins. With Playback Reporting, it sends one query to Playback Reporting's own table through Jellyfin's API (/user_usage_stats/submit_custom_query), 5,000 rows at most. Without it, it reads each user's played films, episodes and audio, 200 a user at most.- The answer is kept in
/data/plays.jsonfor 15 minutes, or until Over the last changes, and every card and table is worked out from it. Check now (POST /refresh) reads it again straight away. - The three tables are read only: a change sent to them answers "These figures are read only".
- The cards' status comes from
band():okwith Playback Reporting,warning("Last plays only") without it. The source card sendsok,needs_setuporproblem. - It starts when needed and stops after 5 minutes with nothing to do.
Find out more
This page on GitHub, where the help is written.