add stats API docs

This commit is contained in:
Simon 2023-11-20 16:35:08 +07:00
parent 6f350ebc34
commit e94cd01cf4
No known key found for this signature in database
GPG Key ID: 2C15AA5E89985DD4
1 changed files with 23 additions and 10 deletions

View File

@ -1,33 +1,46 @@
# Statistics API endpoints
## Primary
⚠️ **Experimental**
All stats endpoints are considered experimental.
⚠️ **Experimental**
## Video
**GET** `/api/stats/primary/`
**GET** `/api/stats/video/`
Get primary statistics for your videos, channels, playlists and download queue.
Get stats for your downloaded videos.
## Channel
**GET** `/api/stats/channel/`
Get stats for your channels.
## Playlist
**GET** `/api/stats/playlist/`
Get stats for your playlists.
## Download
**GET** `/api/stats/download/`
Get stats for your 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.