Faceted search

Introduction

The records facets endpoint is a redesigned and optimized version of the previous facets API. It is intended for improved performance and a simplified structure, making it easier to use and more efficient. This endpoint is available via POST at:

Facet request

This is a brief summary of the main request properties. Each property includes additional fields that allow further configuration. For full details, please refer to the REST API documentation.

• Search
  Limits facets to records matching the query. Can include selected facet values to reflect current selections.

• Source
  Specifies where facets come from: a predefined profile or a custom list of facet fields.

• Value
  Configures options and restrictions per facet field to control how facet values behave and are displayed.

• Locale
  Sets the locale for translating labels and filtering facets accordingly.

• Advanced
  Advanced options, only available for users with function ADMIN_BACKEND_SERVICES.

Facet result

The response from the facets endpoint contains a list of facet fields with their corresponding values. Each field includes:

• Field key and label
  The technical name (DottedKey) and the translated label of the facet field.

• Matching values
  A list of facet values with counts, translated labels, and — for date facets — additional information such as time ranges, edge inclusion, and interval size (year, month, day).

• Has more values
  Indicates whether additional facet values are available beyond those returned.

For a complete overview of the result structure and all available properties, refer to the REST API documentation.