Skip to content

Commit 8628c30

Browse files
v1.14: Add new exhaustiveFacetCount parameter to /facet-search (#3217)
1 parent 743fc32 commit 8628c30

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

reference/api/facet_search.mdx

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -31,14 +31,15 @@ For example, searching for `Jane` will return `Jane Austen`, but searching for `
3131

3232
### Body
3333

34-
| Name | Type | Default value | Description |
35-
| :---------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------- | :------------ | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
36-
| **`facetName`** * | String | `null` | Facet name to search values on |
37-
| **`facetQuery`** | String | `null` | Search query for a given facet value. If `facetQuery` isn't specified, Meilisearch performs a [placeholder search](/reference/api/search#placeholder-search) which returns all facet values for the searched facet, limited to 100 |
38-
| [**`q`**](/reference/api/search#query-q) | String | `""` | Query string |
39-
| **[`filter`](/reference/api/search#filter)** | [String*](/learn/filtering_and_sorting/filter_expression_reference) | `null` | Filter queries by an attribute's value |
40-
| **[`matchingStrategy`](/reference/api/search#matching-strategy)** | String | `last` | Strategy used to match query terms within documents |
41-
| **[`attributesToSearchOn`](/reference/api/search##customize-attributes-to-search-on-at-search-time)** | Array of strings | `null` | Restrict search to the specified attributes |
34+
| Name | Type | Default value | Description |
35+
| ----------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
36+
| **`facetName`** * | String | `null` | Facet name to search values on |
37+
| **`facetQuery`** | String | `null` | Search query for a given facet value. If `facetQuery` isn't specified, Meilisearch returns all facet values for the searched facet, limited to 100 |
38+
| **[`q`](/reference/api/search#query-q)** | String | `""` | Query string |
39+
| **[`filter`](/reference/api/search#filter)** | [String*](/learn/filtering_and_sorting/filter_expression_reference) | `null` | Filter queries by an attribute's value |
40+
| **[`matchingStrategy`](/reference/api/search#matching-strategy)** | String | `"last"` | Strategy used to match query terms within documents |
41+
| **[`attributesToSearchOn`](/reference/api/search##customize-attributes-to-search-on-at-search-time)** | Array of strings | `null` | Restrict search to the specified attributes |
42+
| **`exhaustiveFacetCount`** | Boolean | `false` | Return an exhaustive count of facets, up to the limit defined by [`maxTotalHits`](/reference/api/settings#pagination) |
4243

4344
### Response
4445

0 commit comments

Comments
 (0)