Skip to content

Feature reference audit: search parameters #1016

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from
Closed

Feature reference audit: search parameters #1016

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e6ef23e
Update reference/features/search_parameters: try to make parameters, …
guimachiavelli Jun 24, 2021
33a66f3
Update reference/features/search_parameters: reorder content, change toc
guimachiavelli Jul 6, 2021
e931cb7
Fix broken links
guimachiavelli Jul 6, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions reference/api/search.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ This is the preferred route to perform search when an API key is required, as it
| **limit** | Number of documents to take | `number` |
| **nbHits** | Total number of matches | `number` |
| **exhaustiveNbHits** | Whether `nbHits` is exhaustive | `boolean` |
| **facetsDistribution** | **[Distribution of the given facets](/reference/features/search_parameters.md#the-facets-distribution)** | `object`
| **facetsDistribution** | **[Distribution of the given facets](/reference/features/search_parameters.md#facets-distribution)** | `object`
| **exhaustiveFacetsCount** | Whether `facetsDistribution` is exhaustive | `boolean`
| **processingTimeMs** | Processing time of the query | `number` |
| **query** | Query originating the response | `string` |
Expand Down Expand Up @@ -117,7 +117,7 @@ This route should only be used when no API key is required. If an API key is req
| **[limit](/reference/features/search_parameters.md#limit)** | Maximum number of documents returned | `20` |
| **[filters](/reference/features/search_parameters.md#filters)** | Filter queries by an attribute value | `null` |
| **[facetFilters](/reference/features/search_parameters.md#facet-filters)** | Facet names and values to filter on | `null` |
| **[facetsDistribution](/reference/features/search_parameters.md#the-facets-distribution)** | Facets for which to retrieve the matching count | `null` |
| **[facetsDistribution](/reference/features/search_parameters.md#facets-distribution)** | Facets for which to retrieve the matching count | `null` |
| **[attributesToRetrieve](/reference/features/search_parameters.md#attributes-to-retrieve)** | Attributes to display in the returned documents | `["*"]` |
| **[attributesToCrop](/reference/features/search_parameters.md#attributes-to-crop)** | Attributes whose values have to be cropped | `null` |
| **[cropLength](/reference/features/search_parameters.md#crop-length)** | Length used to crop field values | `200` |
Expand All @@ -142,7 +142,7 @@ When the `q` parameter is not specified, a [placeholder](/reference/features/sea
| **limit** | Number of documents to take | `number` |
| **nbHits** | Total number of matches | `number` |
| **exhaustiveNbHits** | Whether `nbHits` is exhaustive | `boolean` |
| **facetsDistribution** | **[Distribution of the given facets](/reference/features/search_parameters.md#the-facets-distribution)** | `object`
| **facetsDistribution** | **[Distribution of the given facets](/reference/features/search_parameters.md#facets-distribution)** | `object`
| **exhaustiveFacetsCount** | Whether `facetsDistribution` is exhaustive | `boolean`
| **processingTimeMs** | Processing time of the query | `number` |
| **query** | Query originating the response | `string` |
Expand Down
Loading