Videos

Video Stats

Video statistics

Get overall stats of a video

GET

https://peertube2.cpy.re/api/v1/videos/{id}/stats/overall

Get overall stats of a video

curl -X GET 'https://peertube2.cpy.re/api/v1/videos/42/stats/overall' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch('https://peertube2.cpy.re/api/v1/videos/42/stats/overall', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN',
  },
});

const data = await response.text();

import requests

response = requests.get(
    'https://peertube2.cpy.re/api/v1/videos/42/stats/overall',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
    },
)
print(response.text)

200

{
  "averageWatchTime": 0,
  "totalWatchTime": 0,
  "viewersPeak": 0,
  "totalViewers": 0,
  "viewersPeakDate": "2024-01-15T09:30:00Z",
  "countries": [
    {
      "isoCode": "string",
      "viewers": 0
    }
  ],
  "subdivisions": [
    {
      "name": "string",
      "viewers": 0
    }
  ]
}

Parameters

idid | UUIDv4 | shortUUIDrequiredpath

The object id, uuid or short uuid

startDatestring<date-time>query

Filter stats by start date

endDatestring<date-time>query

Filter stats by end date

Response

200OKVideoStatsOverall

successful operation

Response fields application/json

averageWatchTimenumber

totalWatchTimenumber

viewersPeaknumber

totalViewersnumber

viewersPeakDatestring<date-time>

countriesArray<object>

Show child attributes

isoCodestring

viewersnumber

subdivisionsArray<object>

Show child attributes

namestring

viewersnumber

Authorization

OAuth2oauth2

Authenticating via OAuth requires the following steps:

Have an activated account
Generate an access token for that account at /api/v1/users/token.
Make requests with the Authorization: Bearer <token> header
Profit, depending on the role assigned to the account

Note that the access token is valid for 1 day and is given along with a refresh token valid for 2 weeks.

Get user agent stats of a video

GET

https://peertube2.cpy.re/api/v1/videos/{id}/stats/user-agent

Get user agent stats of a video

curl -X GET 'https://peertube2.cpy.re/api/v1/videos/42/stats/user-agent' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch('https://peertube2.cpy.re/api/v1/videos/42/stats/user-agent', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN',
  },
});

const data = await response.text();

import requests

response = requests.get(
    'https://peertube2.cpy.re/api/v1/videos/42/stats/user-agent',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
    },
)
print(response.text)

200

{
  "clients": [
    {
      "name": "string",
      "viewers": 0
    }
  ],
  "devices": [
    {
      "name": "console",
      "viewers": 0
    }
  ],
  "operatingSystem": [
    {
      "name": "string",
      "viewers": 0
    }
  ]
}

Parameters

idid | UUIDv4 | shortUUIDrequiredpath

The object id, uuid or short uuid

startDatestring<date-time>query

Filter stats by start date

endDatestring<date-time>query

Filter stats by end date

Response

200OKVideoStatsUserAgent

successful operation

Response fields application/json

clientsArray<object>

Show child attributes

namestring

viewersnumber

devicesArray<object>

Show child attributes

nameVideoStatsUserAgentDeviceconsoleembeddedmobilesmarttvtabletwearablexrdesktop

viewersnumber

operatingSystemArray<object>

Show child attributes

namestring

viewersnumber

Authorization

OAuth2oauth2

Authenticating via OAuth requires the following steps:

Have an activated account
Generate an access token for that account at /api/v1/users/token.
Make requests with the Authorization: Bearer <token> header
Profit, depending on the role assigned to the account

Note that the access token is valid for 1 day and is given along with a refresh token valid for 2 weeks.

Get retention stats of a video

GET

https://peertube2.cpy.re/api/v1/videos/{id}/stats/retention

Get retention stats of a video

curl -X GET 'https://peertube2.cpy.re/api/v1/videos/42/stats/retention' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch('https://peertube2.cpy.re/api/v1/videos/42/stats/retention', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN',
  },
});

const data = await response.text();

import requests

response = requests.get(
    'https://peertube2.cpy.re/api/v1/videos/42/stats/retention',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
    },
)
print(response.text)

200

{
  "data": [
    {
      "second": 0,
      "retentionPercent": 0
    }
  ]
}

Parameters

idid | UUIDv4 | shortUUIDrequiredpath

The object id, uuid or short uuid

Response

200OKVideoStatsRetention

successful operation

Response fields application/json

dataArray<object>

Show child attributes

secondnumber

retentionPercentnumber

Authorization

OAuth2oauth2

Authenticating via OAuth requires the following steps:

Have an activated account
Generate an access token for that account at /api/v1/users/token.
Make requests with the Authorization: Bearer <token> header
Profit, depending on the role assigned to the account

Note that the access token is valid for 1 day and is given along with a refresh token valid for 2 weeks.

Get timeserie stats of a video

GET

https://peertube2.cpy.re/api/v1/videos/{id}/stats/timeseries/{metric}

Get timeserie stats of a video

curl -X GET 'https://peertube2.cpy.re/api/v1/videos/42/stats/timeseries/viewers' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch('https://peertube2.cpy.re/api/v1/videos/42/stats/timeseries/viewers', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN',
  },
});

const data = await response.text();

import requests

response = requests.get(
    'https://peertube2.cpy.re/api/v1/videos/42/stats/timeseries/viewers',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
    },
)
print(response.text)

200

{
  "data": [
    {
      "date": "string",
      "value": 0
    }
  ]
}

Parameters

idid | UUIDv4 | shortUUIDrequiredpath

The object id, uuid or short uuid

metricstringviewersaggregateWatchTimerequiredpath

The metric to get

startDatestring<date-time>query

Filter stats by start date

endDatestring<date-time>query

Filter stats by end date

Response

200OKVideoStatsTimeserie

successful operation

Response fields application/json

dataArray<object>

Show child attributes

datestring

valuenumber

Authorization

OAuth2oauth2

Authenticating via OAuth requires the following steps:

Have an activated account
Generate an access token for that account at /api/v1/users/token.
Make requests with the Authorization: Bearer <token> header
Profit, depending on the role assigned to the account

Note that the access token is valid for 1 day and is given along with a refresh token valid for 2 weeks.

Docs by Sourcey