aboutsummaryrefslogtreecommitdiffhomepage
path: root/support/doc/api
diff options
context:
space:
mode:
authorChocobozzz <me@florianbigard.com>2022-07-12 14:17:37 +0200
committerChocobozzz <me@florianbigard.com>2022-07-12 14:17:37 +0200
commitb44b5a83ebbc772e1e5c844d6740234142d24d9a (patch)
tree3dee574217c05dc6529129c9bdf1ece3f45975e7 /support/doc/api
parent5d7cb63ede7c4bba93954c0586f589ad9748d5ea (diff)
downloadPeerTube-b44b5a83ebbc772e1e5c844d6740234142d24d9a.tar.gz
PeerTube-b44b5a83ebbc772e1e5c844d6740234142d24d9a.tar.zst
PeerTube-b44b5a83ebbc772e1e5c844d6740234142d24d9a.zip
Add /server/stats API documentation
Diffstat (limited to 'support/doc/api')
-rw-r--r--support/doc/api/openapi.yaml88
1 files changed, 88 insertions, 0 deletions
diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml
index afd310c0b..93c545e36 100644
--- a/support/doc/api/openapi.yaml
+++ b/support/doc/api/openapi.yaml
@@ -293,6 +293,10 @@ tags:
293 PeerTube instances can mirror videos from one another, and help distribute some videos. 293 PeerTube instances can mirror videos from one another, and help distribute some videos.
294 294
295 For importing videos as your own, refer to [video imports](#operation/importVideo). 295 For importing videos as your own, refer to [video imports](#operation/importVideo).
296 - name: Stats
297 description: |
298 Statistics
299
296x-tagGroups: 300x-tagGroups:
297 - name: Auth 301 - name: Auth
298 tags: 302 tags:
@@ -341,6 +345,9 @@ x-tagGroups:
341 - Instance Follows 345 - Instance Follows
342 - Instance Redundancy 346 - Instance Redundancy
343 - Plugins 347 - Plugins
348 - name: Stats
349 tags:
350 - Stats
344 - name: Jobs 351 - name: Jobs
345 tags: 352 tags:
346 - Job 353 - Job
@@ -4294,6 +4301,22 @@ paths:
4294 '404': 4301 '404':
4295 description: video redundancy not found 4302 description: video redundancy not found
4296 4303
4304 /server/stats:
4305 get:
4306 tags:
4307 - Stats
4308 summary: Get instance stats
4309 description: Get instance public statistics. This endpoint is cached.
4310 operationId: getInstanceStats
4311 responses:
4312 '200':
4313 description: successful operation
4314 content:
4315 application/json:
4316 schema:
4317 $ref: '#/components/schemas/ServerStats'
4318
4319
4297 '/feeds/video-comments.{format}': 4320 '/feeds/video-comments.{format}':
4298 get: 4321 get:
4299 tags: 4322 tags:
@@ -6503,6 +6526,71 @@ components:
6503 enabled: 6526 enabled:
6504 type: boolean 6527 type: boolean
6505 6528
6529 ServerStats:
6530 properties:
6531 totalUsers:
6532 type: number
6533 totalDailyActiveUsers:
6534 type: number
6535 totalWeeklyActiveUsers:
6536 type: number
6537 totalMonthlyActiveUsers:
6538 type: number
6539 totalLocalVideos:
6540 type: number
6541 totalLocalVideoViews:
6542 type: number
6543 description: Total video views made on the instance
6544 totalLocalVideoComments:
6545 type: number
6546 description: Total comments made by local users
6547 totalLocalVideoFilesSize:
6548 type: number
6549 totalVideos:
6550 type: number
6551 totalVideoComments:
6552 type: number
6553 totalLocalVideoChannels:
6554 type: number
6555 totalLocalDailyActiveVideoChannels:
6556 type: number
6557 totalLocalWeeklyActiveVideoChannels:
6558 type: number
6559 totalLocalMonthlyActiveVideoChannels:
6560 type: number
6561 totalLocalPlaylists:
6562 type: number
6563 totalInstanceFollowers:
6564 type: number
6565 totalInstanceFollowing:
6566 type: number
6567 videosRedundancy:
6568 type: array
6569 items:
6570 type: object
6571 properties:
6572 strategy:
6573 type: string
6574 totalSize:
6575 type: number
6576 totalUsed:
6577 type: number
6578 totalVideoFiles:
6579 type: number
6580 totalVideos:
6581 type: number
6582 totalActivityPubMessagesProcessed:
6583 type: number
6584 totalActivityPubMessagesSuccesses:
6585 type: number
6586 totalActivityPubMessagesErrors:
6587 type: number
6588
6589 activityPubMessagesProcessedPerSecond:
6590 type: number
6591 totalActivityPubMessagesWaiting:
6592 type: number
6593
6506 ServerConfigAbout: 6594 ServerConfigAbout:
6507 properties: 6595 properties:
6508 instance: 6596 instance: