Instance

Stats

Statistics

Get instance stats

GET

https://peertube2.cpy.re/api/v1/server/stats

Get instance public statistics. This endpoint is cached.

Get instance stats

curl -X GET 'https://peertube2.cpy.re/api/v1/server/stats'

const response = await fetch('https://peertube2.cpy.re/api/v1/server/stats', {
  method: 'GET',
});

const data = await response.text();

import requests

response = requests.get('https://peertube2.cpy.re/api/v1/server/stats')
print(response.text)

200

{
  "totalUsers": 0,
  "totalDailyActiveUsers": 0,
  "totalWeeklyActiveUsers": 0,
  "totalMonthlyActiveUsers": 0,
  "totalModerators": 0,
  "totalAdmins": 0,
  "totalLocalVideos": 0,
  "totalLocalVideoViews": 0,
  "totalLocalVideoDownloads": 0,
  "totalLocalVideoComments": 0,
  "totalLocalVideoFilesSize": 0,
  "totalVideos": 0,
  "totalVideoComments": 0,
  "totalLocalVideoChannels": 0,
  "totalLocalDailyActiveVideoChannels": 0,
  "totalLocalWeeklyActiveVideoChannels": 0,
  "totalLocalMonthlyActiveVideoChannels": 0,
  "totalLocalPlaylists": 0,
  "totalInstanceFollowers": 0,
  "totalInstanceFollowing": 0,
  "videosRedundancy": [
    {
      "strategy": "string",
      "totalSize": 0,
      "totalUsed": 0,
      "totalVideoFiles": 0,
      "totalVideos": 0
    }
  ],
  "totalActivityPubMessagesProcessed": 0,
  "totalActivityPubMessagesSuccesses": 0,
  "totalActivityPubMessagesErrors": 0,
  "activityPubMessagesProcessedPerSecond": 0,
  "totalActivityPubMessagesWaiting": 0,
  "averageRegistrationRequestResponseTimeMs": 0,
  "totalRegistrationRequestsProcessed": 0,
  "totalRegistrationRequests": 0,
  "averageAbuseResponseTimeMs": 0,
  "totalAbusesProcessed": 0,
  "totalAbuses": 0
}

Response

200OKServerStats

successful operation

Response fields application/json

totalUsersnumber

totalDailyActiveUsersnumber

totalWeeklyActiveUsersnumber

totalMonthlyActiveUsersnumber

totalModeratorsnumber

PeerTube >= 6.1 Value is null if the admin disabled total moderators stats

totalAdminsnumber

PeerTube >= 6.1 Value is null if the admin disabled total admins stats

totalLocalVideosnumber

totalLocalVideoViewsnumber

Total video views made on the instance

totalLocalVideoDownloadsnumber

Total video downloads made on the instance

totalLocalVideoCommentsnumber

Total comments made by local users

totalLocalVideoFilesSizenumber

totalVideosnumber

totalVideoCommentsnumber

totalLocalVideoChannelsnumber

totalLocalDailyActiveVideoChannelsnumber

totalLocalWeeklyActiveVideoChannelsnumber

totalLocalMonthlyActiveVideoChannelsnumber

totalLocalPlaylistsnumber

totalInstanceFollowersnumber

totalInstanceFollowingnumber

videosRedundancyArray<object>

Show child attributes

strategystring

totalSizenumber

totalUsednumber

totalVideoFilesnumber

totalVideosnumber

totalActivityPubMessagesProcessednumber

totalActivityPubMessagesSuccessesnumber

totalActivityPubMessagesErrorsnumber

activityPubMessagesProcessedPerSecondnumber

totalActivityPubMessagesWaitingnumber

averageRegistrationRequestResponseTimeMsnumber

PeerTube >= 6.1 Value is null if the admin disabled registration requests stats

totalRegistrationRequestsProcessednumber

PeerTube >= 6.1 Value is null if the admin disabled registration requests stats

totalRegistrationRequestsnumber

PeerTube >= 6.1 Value is null if the admin disabled registration requests stats

averageAbuseResponseTimeMsnumber

PeerTube >= 6.1 Value is null if the admin disabled abuses stats

totalAbusesProcessednumber

PeerTube >= 6.1 Value is null if the admin disabled abuses stats

totalAbusesnumber

PeerTube >= 6.1 Value is null if the admin disabled abuses stats

Create playback metrics

POST

https://peertube2.cpy.re/api/v1/metrics/playback

These metrics are exposed by OpenTelemetry metrics exporter if enabled.

Create playback metrics

curl -X POST 'https://peertube2.cpy.re/api/v1/metrics/playback' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "playerMode": "p2p-media-loader",
  "resolution": 0,
  "fps": 0,
  "p2pEnabled": true,
  "p2pPeers": 0,
  "resolutionChanges": 0,
  "bufferStalled": 0,
  "errors": 0,
  "downloadedBytesP2P": 0,
  "downloadedBytesHTTP": 0,
  "uploadedBytesP2P": 0,
  "videoId": 42
}'

const body = `{
  "playerMode": "p2p-media-loader",
  "resolution": 0,
  "fps": 0,
  "p2pEnabled": true,
  "p2pPeers": 0,
  "resolutionChanges": 0,
  "bufferStalled": 0,
  "errors": 0,
  "downloadedBytesP2P": 0,
  "downloadedBytesHTTP": 0,
  "uploadedBytesP2P": 0,
  "videoId": 42
}`;

const response = await fetch('https://peertube2.cpy.re/api/v1/metrics/playback', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body,
});

const data = await response.text();

import requests

body = '''{
  "playerMode": "p2p-media-loader",
  "resolution": 0,
  "fps": 0,
  "p2pEnabled": true,
  "p2pPeers": 0,
  "resolutionChanges": 0,
  "bufferStalled": 0,
  "errors": 0,
  "downloadedBytesP2P": 0,
  "downloadedBytesHTTP": 0,
  "uploadedBytesP2P": 0,
  "videoId": 42
}'''

response = requests.post(
    'https://peertube2.cpy.re/api/v1/metrics/playback',
    data=body.encode('utf-8'),
    headers={
        'Content-Type': 'application/json',
    },
)
print(response.text)

Request Body

{
  "playerMode": "p2p-media-loader",
  "resolution": 0,
  "fps": 0,
  "p2pEnabled": true,
  "p2pPeers": 0,
  "resolutionChanges": 0,
  "bufferStalled": 0,
  "errors": 0,
  "downloadedBytesP2P": 0,
  "downloadedBytesHTTP": 0,
  "uploadedBytesP2P": 0,
  "videoId": 42
}

Body

application/json

playerModestringp2p-media-loaderweb-videorequired

resolutionnumber

Current player video resolution

fpsnumber

Current player video fps

p2pEnabledbooleanrequired

p2pPeersnumber

P2P peers connected (doesn't include WebSeed peers)

resolutionChangesnumberrequired

How many resolution changes occurred since the last metric creation

bufferStallednumber

How many times buffer has been stalled since the last metric creation

errorsnumberrequired

How many errors occurred since the last metric creation

downloadedBytesP2Pnumberrequired

How many bytes were downloaded with P2P since the last metric creation

downloadedBytesHTTPnumberrequired

How many bytes were downloaded with HTTP since the last metric creation

uploadedBytesP2Pnumberrequired

How many bytes were uploaded with P2P since the last metric creation

videoIdid | UUIDv4 | shortUUIDrequired

Show child attributes

One of

id>= 1

Example

UUIDv4<uuid>

Example

9c9de5e8-0a1e-484a-b099-e80766180a6d

translation of a uuid v4 with a bigger alphabet to have a shorter uuid

shortUUID

Example

2y84q2MQUMWPbiEcxNXMgC

Response

204No Content

successful operation

Docs by Sourcey