Add /server/stats API documentation

pull/5138/head
Chocobozzz 2022-07-12 14:17:37 +02:00
parent 5d7cb63ede
commit b44b5a83eb
No known key found for this signature in database
GPG Key ID: 583A612D890159BE
1 changed files with 88 additions and 0 deletions

View File

@ -293,6 +293,10 @@ tags:
PeerTube instances can mirror videos from one another, and help distribute some videos. PeerTube instances can mirror videos from one another, and help distribute some videos.
For importing videos as your own, refer to [video imports](#operation/importVideo). For importing videos as your own, refer to [video imports](#operation/importVideo).
- name: Stats
description: |
Statistics
x-tagGroups: x-tagGroups:
- name: Auth - name: Auth
tags: tags:
@ -341,6 +345,9 @@ x-tagGroups:
- Instance Follows - Instance Follows
- Instance Redundancy - Instance Redundancy
- Plugins - Plugins
- name: Stats
tags:
- Stats
- name: Jobs - name: Jobs
tags: tags:
- Job - Job
@ -4294,6 +4301,22 @@ paths:
'404': '404':
description: video redundancy not found description: video redundancy not found
/server/stats:
get:
tags:
- Stats
summary: Get instance stats
description: Get instance public statistics. This endpoint is cached.
operationId: getInstanceStats
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ServerStats'
'/feeds/video-comments.{format}': '/feeds/video-comments.{format}':
get: get:
tags: tags:
@ -6503,6 +6526,71 @@ components:
enabled: enabled:
type: boolean type: boolean
ServerStats:
properties:
totalUsers:
type: number
totalDailyActiveUsers:
type: number
totalWeeklyActiveUsers:
type: number
totalMonthlyActiveUsers:
type: number
totalLocalVideos:
type: number
totalLocalVideoViews:
type: number
description: Total video views made on the instance
totalLocalVideoComments:
type: number
description: Total comments made by local users
totalLocalVideoFilesSize:
type: number
totalVideos:
type: number
totalVideoComments:
type: number
totalLocalVideoChannels:
type: number
totalLocalDailyActiveVideoChannels:
type: number
totalLocalWeeklyActiveVideoChannels:
type: number
totalLocalMonthlyActiveVideoChannels:
type: number
totalLocalPlaylists:
type: number
totalInstanceFollowers:
type: number
totalInstanceFollowing:
type: number
videosRedundancy:
type: array
items:
type: object
properties:
strategy:
type: string
totalSize:
type: number
totalUsed:
type: number
totalVideoFiles:
type: number
totalVideos:
type: number
totalActivityPubMessagesProcessed:
type: number
totalActivityPubMessagesSuccesses:
type: number
totalActivityPubMessagesErrors:
type: number
activityPubMessagesProcessedPerSecond:
type: number
totalActivityPubMessagesWaiting:
type: number
ServerConfigAbout: ServerConfigAbout:
properties: properties:
instance: instance: