From e94cd01cf4985a75d11c85e7cba7514bd7860ee7 Mon Sep 17 00:00:00 2001 From: Simon Date: Mon, 20 Nov 2023 16:35:08 +0700 Subject: [PATCH] add stats API docs --- mkdocs/docs/api/stats.md | 33 +++++++++++++++++++++++---------- 1 file changed, 23 insertions(+), 10 deletions(-) diff --git a/mkdocs/docs/api/stats.md b/mkdocs/docs/api/stats.md index 9cc1f4a..46ecd69 100644 --- a/mkdocs/docs/api/stats.md +++ b/mkdocs/docs/api/stats.md @@ -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.