CalendarHeatmapResponseDto

Endpoints · All schemas

Field	Required	Description
from	Yes	Start date in UTC
series	Yes	array
to	Yes	End date in UTC
totalCount	Yes	Total activity count over the period

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": {
    "from": {
      "description": "Start date in UTC",
      "example": "2024-01-01",
      "type": "string"
    },
    "series": {
      "items": {
        "properties": {
          "count": {
            "description": "Activity count",
            "maximum": 9007199254740991,
            "minimum": 0,
            "type": "integer"
          },
          "date": {
            "description": "Date in UTC",
            "example": "2024-01-01",
            "type": "string"
          }
        },
        "required": [
          "date",
          "count"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "to": {
      "description": "End date in UTC",
      "example": "2024-12-31",
      "type": "string"
    },
    "totalCount": {
      "description": "Total activity count over the period",
      "maximum": 9007199254740991,
      "minimum": 0,
      "type": "integer"
    }
  },
  "required": [
    "from",
    "series",
    "to",
    "totalCount"
  ],
  "type": "object"
}