Channels Sync

List the synchronizations of video channels of an account

GET

https://peertube2.cpy.re/api/v1/accounts/{name}/video-channel-syncs

curl -X GET 'https://peertube2.cpy.re/api/v1/accounts/chocobozzz%20%7C%20chocobozzz%40example.org/video-channel-syncs?count=15'

const response = await fetch('https://peertube2.cpy.re/api/v1/accounts/chocobozzz%20%7C%20chocobozzz%40example.org/video-channel-syncs?count=15', {
  method: 'GET',
});

const data = await response.text();

import requests

response = requests.get('https://peertube2.cpy.re/api/v1/accounts/chocobozzz%20%7C%20chocobozzz%40example.org/video-channel-syncs?count=15')
print(response.text)

200

{
  "total": 1,
  "data": [
    {
      "id": 42,
      "state": {
        "id": 2,
        "label": "PROCESSING"
      },
      "externalChannelUrl": "https://youtube.com/c/UC_myfancychannel",
      "createdAt": "2024-01-15T09:30:00Z",
      "lastSyncAt": "2024-01-15T09:30:00Z",
      "channel": {
        "id": 42,
        "url": "https://example.com",
        "avatars": [
          {
            "path": "string",
            "fileUrl": "string",
            "width": 0,
            "height": 0,
            "createdAt": "2024-01-15T09:30:00Z",
            "updatedAt": "2024-01-15T09:30:00Z"
          }
        ],
        "host": "example.com",
        "hostRedundancyAllowed": true,
        "followingCount": 0,
        "followersCount": 0,
        "createdAt": "2024-01-15T09:30:00Z",
        "updatedAt": "2024-01-15T09:30:00Z",
        "displayName": "Videos of Framasoft",
        "description": "Videos made with <3 by Framasoft",
        "support": "Please support our work on https://soutenir.framasoft.org/en/ <3",
        "publicEmail": "user@example.com",
        "isLocal": true,
        "banners": [
          {
            "path": "string",
            "fileUrl": "string",
            "width": 0,
            "height": 0,
            "createdAt": "2024-01-15T09:30:00Z",
            "updatedAt": "2024-01-15T09:30:00Z"
          }
        ],
        "ownerAccount": {
          "id": 42,
          "url": "https://example.com",
          "avatars": [
            {
              "path": "string",
              "fileUrl": "string",
              "width": 0,
              "height": 0,
              "createdAt": "2024-01-15T09:30:00Z",
              "updatedAt": "2024-01-15T09:30:00Z"
            }
          ],
          "host": "example.com",
          "hostRedundancyAllowed": true,
          "followingCount": 0,
          "followersCount": 0,
          "createdAt": "2024-01-15T09:30:00Z",
          "updatedAt": "2024-01-15T09:30:00Z",
          "displayName": "string",
          "description": "string"
        },
        "videosCount": 0,
        "viewsPerDay": [
          {
            "date": "2024-01-15T09:30:00Z",
            "views": 0
          }
        ],
        "viewsGroupInterval": "day",
        "totalViews": 0
      },
      "videoPrivacy": 0
    }
  ]
}

Parameters

namestringrequiredpath

The username or handle of the account

startinteger>= 0query

Offset used to paginate results

countinteger[1, 100]15query

Number of items to return

sortstringquery

Sort column

includeCollaborationsbooleanquery

PeerTube >= 8.0 Include objects from collaborated channels

Response

200OKVideoChannelSyncList

successful operation

Response fields application/json

totalinteger

Example

dataArray<VideoChannelSync>

Show child attributes

idid>= 1

Example

stateobject

Show child attributes

idinteger

Example

labelstring

Example

PROCESSING

externalChannelUrlstring

Example

https://youtube.com/c/UC_myfancychannel

createdAtstring<date-time>

lastSyncAtstring<date-time> | null

channelActor & object

Show child attributes

idid>= 1

Example

urlstring<url>

nameusername

immutable name of the actor, used to find or mention it

Show child attributes

immutable name of the user, used to find or mention its actor

username

Example

chocobozzz

avatarsArray<ActorImage>

Show child attributes

pathstring | nulldeprecated

Deprecated in PeerTube v8.0, use fileUrl instead. Null if the file is stored in object storage: use the non-deprecated field instead.

fileUrlstring

PeerTube >= 7.1

widthinteger

heightinteger

PeerTube >= 7.3

createdAtstring<date-time>

updatedAtstring<date-time>

hoststring<hostname>

server on which the actor is resident

hostRedundancyAllowedboolean | null

whether this actor's host allows redundancy of its videos

followingCountinteger>= 0

number of actors subscribed to by this actor, as seen by this instance

followersCountinteger>= 0

number of followers of this actor, as seen by this instance

createdAtstring<date-time>

updatedAtstring<date-time>

displayNamestring

editable name of the channel, displayed in its representations

Example

Videos of Framasoft

descriptionstring | null

Example

Videos made with <3 by Framasoft

supportstring | null

text shown by default on all videos of this channel, to tell the audience how to support it

Example

Please support our work on https://soutenir.framasoft.org/en/ <3

publicEmailstring<email> | null

Public email visible in podcast RSS feeds

isLocalboolean

updatedAtstring<date-time>

bannersArray<ActorImage>

Show child attributes

pathstring | nulldeprecated

Deprecated in PeerTube v8.0, use fileUrl instead. Null if the file is stored in object storage: use the non-deprecated field instead.

fileUrlstring

PeerTube >= 7.1

widthinteger

heightinteger

PeerTube >= 7.3

createdAtstring<date-time>

updatedAtstring<date-time>

ownerAccountActor & any

Show child attributes

idid>= 1

Example

urlstring<url>

nameusername

immutable name of the actor, used to find or mention it

Show child attributes

immutable name of the user, used to find or mention its actor

username

Example

chocobozzz

avatarsArray<ActorImage>

Show child attributes

pathstring | nulldeprecated

Deprecated in PeerTube v8.0, use fileUrl instead. Null if the file is stored in object storage: use the non-deprecated field instead.

fileUrlstring

PeerTube >= 7.1

widthinteger

heightinteger

PeerTube >= 7.3

createdAtstring<date-time>

updatedAtstring<date-time>

hoststring<hostname>

server on which the actor is resident

hostRedundancyAllowedboolean | null

whether this actor's host allows redundancy of its videos

followingCountinteger>= 0

number of actors subscribed to by this actor, as seen by this instance

followersCountinteger>= 0

number of followers of this actor, as seen by this instance

createdAtstring<date-time>

updatedAtstring<date-time>

userIdid | null

object id for the user tied to this account

Show child attributes

id>= 1

Example

displayNamestring

editable name of the account, displayed in its representations

descriptionstring | null

text or bio displayed on the account's profile

videosCountinteger

only included when withStats is true

viewsPerDayArray<object>

only included when withStats is true. Chronologically ordered, spans the whole statsDays range. Each point aggregates viewsGroupInterval worth of views, starting at date

Show child attributes

datestring<date-time>

viewsinteger

viewsGroupIntervalstringdayweekmonth

bucket size of viewsPerDay, only included when withStats is true

totalViewsinteger

lifetime views of all the channel videos, only included when withStats is true

videoPrivacyinteger | null

Default privacy of videos imported by this synchronization

Docs by Sourcey