Manticore Search · Schema

aggHistogram

Object to use histograms in aggregation, i.e., grouping search results by histogram values

SearchFull-Text SearchVector SearchElasticsearch CompatibleOpen SourceDatabase

Properties

Name Type Description
field string Field to group by
interval integer Interval of the histogram values
offset integer Offset of the histogram values. Default value is 0.
keyed boolean Flag that defines if a search response will be a dictionary with the bucket keys. Default value is false.
View JSON Schema on GitHub

JSON Schema

aggHistogram.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/manticore/main/json-schema/aggHistogram.json",
  "title": "aggHistogram",
  "description": "Object to use histograms in aggregation, i.e., grouping search results by histogram values",
  "additionalProperties": false,
  "properties": {
    "field": {
      "description": "Field to group by",
      "example": "field",
      "type": "string"
    },
    "interval": {
      "description": "Interval of the histogram values",
      "example": 10,
      "type": "integer"
    },
    "offset": {
      "description": "Offset of the histogram values. Default value is 0.",
      "example": 1,
      "type": "integer"
    },
    "keyed": {
      "description": "Flag that defines if a search response will be a dictionary with the bucket keys. Default value is false.",
      "example": true,
      "type": "boolean"
    }
  },
  "required": [
    "field",
    "interval"
  ]
}