get
https://{yourinstance}.makaira.io/aggregation
Get list of all aggregations
Returns a list of all filter aggregations (facets) configured for the current instance. Aggregations define the filters available in search results.
Requires authentication.
Request
GET /aggregation
Headers
| Header | Value |
|---|---|
Authorization | Bearer <token> |
Response
Returns a JSON array of aggregation objects.
Response Body
| Field | Type | Description |
|---|---|---|
id | integer | Unique aggregation ID. |
title | string | Display title shown in the filter UI. |
field | string | The document field this aggregation is based on. |
type | string | Aggregation type. |
key | string | Machine-readable key used in search requests and responses. |
active | boolean | Whether this aggregation is currently active. |
position | number | Display order position. |
sorting | string | How the aggregation values are sorted. |
showCount | boolean | When true, the count of matching documents is shown next to each value. |
showActiveOnTop | boolean | When true, selected filter values are shown at the top. |
useAttributeTitle | boolean | When true, uses the attribute's own title instead of the configured title. |
OK