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

View File

@ -1,33 +1,46 @@
# Statistics API endpoints # Statistics API endpoints
## Primary
⚠️ **Experimental** ⚠️ **Experimental**
All stats endpoints are considered experimental.
**GET** `/api/stats/primary/` ## Video
Get primary statistics for your videos, channels, playlists and download queue. **GET** `/api/stats/video/`
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 ## Watch Progress
⚠️ **Experimental**
**GET** `/api/stats/watch/` **GET** `/api/stats/watch/`
Get statistics over your watch progress. Get statistics over your watch progress.
## Download History ## Download History
⚠️ **Experimental**
**GET** `/api/stats/downloadhist/` **GET** `/api/stats/downloadhist/`
Get statistics for last days download history. Get statistics for last days download history.
## Biggest Channels ## Biggest Channels
⚠️ **Experimental**
**GET** `/api/stats/biggestchannels/` **GET** `/api/stats/biggestchannels/`
Get a list of biggest channels, specify *order* parameter. Get a list of biggest channels, specify *order* parameter.