Returns the list of available index fields that can be used as aggregation sources. Results can be filtered by field type.
Requires one of the following permissions: aggregation:fields:read, menu.read, search.read, banner.read, redirects.read, datainspector.read, streams.read, pageeditor.read, or settings.read.
Request
GET /aggregation/fields
Headers
| Header | Value |
|---|---|
Authorization | Bearer <token> |
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
type | string | No | Comma-separated list of field types to include (e.g. "text,keyword"). The value "string" is treated as "text". |
exclude_type | string | No | Comma-separated list of field types to exclude. |
no_public_field | boolean | No | When true, fields already used as public fields are excluded from the result. |
Example Request
GET /aggregation/fields?type=keyword
Authorization: Bearer <token>Response
Returns a JSON array of field descriptor objects.
Response Body
Each item in the array:
| Field | Type | Description |
|---|---|---|
title | string | The field name as used in the index. |
type | string | The field data type (e.g. "keyword", "text", "integer", "float"). |
Example Response
[
{
"title": "manufacturer",
"type": "keyword"
},
{
"title": "price",
"type": "float"
}
]