AnalyticsScopeOptionDto

Endpoints · All schemas

Field	Required	Description
kind	Yes	See definition below
label	Yes	Account or library name; empty for the whole server
libraryId	Yes	string
removed	Yes	The account or library has been removed; its items may still count until deleted
userId	Yes	The account, or the library owner
value	Yes	The value to pass as `scope`

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: AnalyticsScopeKind

{
  "properties": {
    "kind": {
      "$ref": "#/components/schemas/AnalyticsScopeKind"
    },
    "label": {
      "description": "Account or library name; empty for the whole server",
      "type": "string"
    },
    "libraryId": {
      "nullable": true,
      "type": "string"
    },
    "removed": {
      "description": "The account or library has been removed; its items may still count until deleted",
      "type": "boolean"
    },
    "userId": {
      "description": "The account, or the library owner",
      "nullable": true,
      "type": "string"
    },
    "value": {
      "description": "The value to pass as `scope`",
      "type": "string"
    }
  },
  "required": [
    "kind",
    "label",
    "libraryId",
    "removed",
    "userId",
    "value"
  ],
  "type": "object"
}