AnalyticsVolumeBreakdownDto

Endpoints · All schemas

What uses the library volume, only in the whole-server report; the parts and otherBytes add up to volumeUsedBytes

Field	Required	Description
databaseBytes	Yes	This server database on disk (pg_database_size)
encodedVideoBytes	Yes	Encoded video folder, from the nightly collector; null before its first reading
exceedsUsed	Yes	The measured parts add up to more than the volume used, for example a database on another disk; otherBytes is then 0
generatedObservedAt	Yes	When the generated folders were last measured
onOtherDisk	Yes	Generated folders the collector found on another disk than the library; not part of volumeUsedBytes
originalsBytes	Yes	Uploaded original files on the volume, each shared file counted once (Locked excluded)
otherBytes	Yes	volumeUsedBytes minus every measured part: other files on the volume, Locked originals and anything unmeasured
previewsBytes	Yes	Thumbnail and preview folder, from the nightly collector; null before its first reading

Complete definition

required lists fields that must be present. nullable allows a null value; it does not make the field optional. Response enums retain exact wire values for compatibility.

Field definitions: AnalyticsVolumePart

{
  "description": "What uses the library volume, only in the whole-server report; the parts and otherBytes add up to volumeUsedBytes",
  "properties": {
    "databaseBytes": {
      "description": "This server database on disk (pg_database_size)",
      "maximum": 9007199254740991,
      "minimum": 0,
      "type": "integer"
    },
    "encodedVideoBytes": {
      "description": "Encoded video folder, from the nightly collector; null before its first reading",
      "maximum": 9007199254740991,
      "minimum": 0,
      "nullable": true,
      "type": "integer"
    },
    "exceedsUsed": {
      "description": "The measured parts add up to more than the volume used, for example a database on another disk; otherBytes is then 0",
      "type": "boolean"
    },
    "generatedObservedAt": {
      "description": "When the generated folders were last measured",
      "format": "date-time",
      "nullable": true,
      "type": "string"
    },
    "onOtherDisk": {
      "description": "Generated folders the collector found on another disk than the library; not part of volumeUsedBytes",
      "items": {
        "$ref": "#/components/schemas/AnalyticsVolumePart"
      },
      "type": "array"
    },
    "originalsBytes": {
      "description": "Uploaded original files on the volume, each shared file counted once (Locked excluded)",
      "maximum": 9007199254740991,
      "minimum": 0,
      "type": "integer"
    },
    "otherBytes": {
      "description": "volumeUsedBytes minus every measured part: other files on the volume, Locked originals and anything unmeasured",
      "maximum": 9007199254740991,
      "minimum": 0,
      "type": "integer"
    },
    "previewsBytes": {
      "description": "Thumbnail and preview folder, from the nightly collector; null before its first reading",
      "maximum": 9007199254740991,
      "minimum": 0,
      "nullable": true,
      "type": "integer"
    }
  },
  "required": [
    "databaseBytes",
    "encodedVideoBytes",
    "exceedsUsed",
    "generatedObservedAt",
    "onOtherDisk",
    "originalsBytes",
    "otherBytes",
    "previewsBytes"
  ],
  "type": "object"
}