Skip to content

YearInReviewDto

Endpoints · All schemas

FieldRequiredDescription
assetCountYesNumber of assets captured that year
kindYesDiscriminator for a year in review recap
monthCountYesNumber of distinct months represented
yearYesCalendar year being recapped

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.

{
  "properties": {
    "assetCount": {
      "description": "Number of assets captured that year",
      "maximum": 9007199254740991,
      "minimum": 0,
      "type": "integer"
    },
    "kind": {
      "description": "Discriminator for a year in review recap",
      "enum": [
        "year_in_review"
      ],
      "type": "string"
    },
    "monthCount": {
      "description": "Number of distinct months represented",
      "maximum": 9007199254740991,
      "minimum": 0,
      "type": "integer"
    },
    "year": {
      "description": "Calendar year being recapped",
      "maximum": 9999,
      "minimum": 1000,
      "type": "integer"
    }
  },
  "required": [
    "assetCount",
    "kind",
    "monthCount",
    "year"
  ],
  "type": "object"
}