UserViewingVideo

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/peertube/main/json-schema/UserViewingVideo.json",
  "title": "UserViewingVideo",
  "required": [
    "currentTime"
  ],
  "properties": {
    "currentTime": {
      "type": "integer",
      "format": "seconds",
      "description": "timestamp within the video, in seconds",
      "example": 5
    },
    "viewEvent": {
      "type": "string",
      "enum": [
        "seek"
      ],
      "description": "Event since last viewing call:\n * `seek` - If the user seeked the video\n"
    },
    "sessionId": {
      "type": "string",
      "description": "Optional param to represent the current viewer session. Used by the backend to properly count one view per session per video. PeerTube admin can configure the server to not trust this `sessionId` parameter but use the request IP address instead to identify a viewer.\n"
    },
    "client": {
      "type": "string",
      "description": "Client software used to watch the video. For example \"Firefox\", \"PeerTube Approval Android\", etc.\n"
    },
    "device": {
      "description": "Device used to watch the video. For example \"desktop\", \"mobile\", \"smarttv\", etc.\n",
      "allOf": [
        {
          "$ref": "#/components/schemas/VideoStatsUserAgentDevice"
        }
      ]
    },
    "operatingSystem": {
      "type": "string",
      "description": "Operating system used to watch the video. For example \"Windows\", \"Ubuntu\", etc.\n"
    }
  }
}