add stats api docs

This commit is contained in:
Simon 2023-09-04 17:47:24 +07:00
parent f37129a7bc
commit 4599cbee54
No known key found for this signature in database
GPG Key ID: 2C15AA5E89985DD4
2 changed files with 38 additions and 0 deletions

37
mkdocs/docs/api/stats.md Normal file
View File

@ -0,0 +1,37 @@
# Statistics API endpoints
## Primary
⚠️ **Experimental**
**GET** `/api/stats/primary/`
Get primary statistics for your videos, channels, playlists and download queue.
## Watch Progress
⚠️ **Experimental**
**GET** `/api/stats/watch/`
Get statistics over your watch progress.
## Download History
⚠️ **Experimental**
**GET** `/api/stats/downloadhist/`
Get statistics for last days download history.
## Biggest Channels
⚠️ **Experimental**
**GET** `/api/stats/biggestchannels/`
Get a list of biggest channels, specify *order* parameter.
Parameter:
- order: doc_count (default), duration, media_size

View File

@ -36,6 +36,7 @@ nav:
- 'Download': 'api/download.md'
- 'Snapshot': 'api/snapshot.md'
- 'Task': 'api/task.md'
- 'Stats': 'api/stats.md'
- 'Additional': 'api/additional.md'
- Links:
- 'Main site': https://www.tubearchivist.com