Skip to content

SearchHistogramResponseDto

Endpoints · All schemas

FieldRequiredDescription
bucketsYesNon-empty buckets by local capture date, oldest first
granularityYesSee definition below
totalYesSum of every bucket; equals POST /search/statistics for the same body

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: SearchHistogramBucketDto, SearchHistogramGranularity

{
  "properties": {
    "buckets": {
      "description": "Non-empty buckets by local capture date, oldest first",
      "items": {
        "$ref": "#/components/schemas/SearchHistogramBucketDto"
      },
      "type": "array"
    },
    "granularity": {
      "$ref": "#/components/schemas/SearchHistogramGranularity"
    },
    "total": {
      "description": "Sum of every bucket; equals POST /search/statistics for the same body",
      "maximum": 9007199254740991,
      "minimum": 0,
      "type": "integer"
    }
  },
  "required": [
    "buckets",
    "granularity",
    "total"
  ],
  "type": "object"
}