Search an index

Searches a single index and return matching search results (hits).

This method lets you retrieve up to 1,000 hits. If you need more, use the browse operation or increase the paginatedLimitedTo index setting.

Authorizations

x-algolia-application-id

string

headerrequired

Your Algolia application ID.

x-algolia-api-key

string

headerrequired

Your Algolia API key with the necessary permissions to make the request. Permissions are controlled through access control lists (ACL) and access restrictions. The required ACL to make a request is listed in each endpoint's reference.

Path Parameters

indexName

string

required

Name of the index on which to perform the operation.

Body

application/json

• Option 1
• Search parameters as object

Search parameters as query string.

params

string

default:

Search parameters as a URL-encoded query string.

Response

200 - application/json

processingTimeMS

integer

required

Time the server took to process the request, in milliseconds.

page

integer

default: 0required

Page of search results to retrieve.

Required range: x > 0

nbHits

integer

required

Number of results (hits).

nbPages

integer

required

Number of pages of results.

hitsPerPage

integer

default: 20required

Number of hits per page.

Required range: 1 < x < 1000

hits

object[]

required

Search results (hits).

Hits are records from your index that match the search criteria, augmented with additional attributes, such as, for highlighting.

Show child attributes

hits.objectID

string

required

Unique record identifier.

hits._highlightResult

object

Surround words that match the query with HTML tags for highlighting.

Show child attributes

hits._highlightResult.{key}

Surround words that match the query with HTML tags for highlighting.

Show child attributes

hits._highlightResult.{key}.value

string

required

Highlighted attribute value, including HTML tags.

hits._highlightResult.{key}.matchLevel

enum<string>

required

Whether the whole query string matches or only a part.

Available options:

none,

partial,

full

hits._highlightResult.{key}.matchedWords

string[]

required

List of matched words from the search query.

hits._highlightResult.{key}.fullyHighlighted

boolean

Whether the entire attribute value is highlighted.

hits._snippetResult

object

Snippets that show the context around a matching search query.

Show child attributes

hits._snippetResult.{key}

Snippets that show the context around a matching search query.

Show child attributes

hits._snippetResult.{key}.value

string

required

Highlighted attribute value, including HTML tags.

hits._snippetResult.{key}.matchLevel

enum<string>

required

Whether the whole query string matches or only a part.

Available options:

none,

partial,

full

hits._rankingInfo

object

Object with detailed information about the record's ranking.

Show child attributes

hits._rankingInfo.firstMatchedWord

integer

required

Position of the first matched word in the best matching attribute of the record.

Required range: x > 0

hits._rankingInfo.geoDistance

integer

required

Distance between the geo location in the search query and the best matching geo location in the record, divided by the geo precision (in meters).

Required range: x > 0

hits._rankingInfo.nbExactWords

integer

required

Number of exactly matched words.

Required range: x > 0

hits._rankingInfo.nbTypos

integer

required

Number of typos encountered when matching the record.

Required range: x > 0

hits._rankingInfo.userScore

integer

required

Overall ranking of the record, expressed as a single integer. This attribute is internal.

hits._rankingInfo.filters

integer

Whether a filter matched the query.

Required range: x > 0

hits._rankingInfo.geoPrecision

integer

Precision used when computing the geo distance, in meters.

Required range: x > 1

hits._rankingInfo.matchedGeoLocation

object

Show child attributes

hits._rankingInfo.matchedGeoLocation.lat

number

Latitude of the matched location.

hits._rankingInfo.matchedGeoLocation.lng

number

Longitude of the matched location.

hits._rankingInfo.matchedGeoLocation.distance

integer

Distance between the matched location and the search location (in meters).

hits._rankingInfo.personalization

object

Show child attributes

hits._rankingInfo.personalization.filtersScore

integer

The score of the filters.

hits._rankingInfo.personalization.rankingScore

integer

The score of the ranking.

hits._rankingInfo.personalization.score

integer

The score of the event.

hits._rankingInfo.promoted

boolean

Whether the record was promoted by a rule.

hits._rankingInfo.proximityDistance

integer

Number of words between multiple matches in the query plus 1. For single word queries, proximityDistance is 0.

Required range: x > 0

hits._rankingInfo.words

integer

Number of matched words.

Required range: x > 1

hits._rankingInfo.promotedByReRanking

boolean

Whether the record is re-ranked.

hits._distinctSeqID

integer

query

string

default: required

Search query.

params

string

required

URL-encoded string of all search parameters.

abTestID

integer

A/B test ID. This is only included in the response for indices that are part of an A/B test.

abTestVariantID

integer

Variant ID. This is only included in the response for indices that are part of an A/B test.

Required range: x > 1

aroundLatLng

string

Computed geographical location.

automaticRadius

string

Distance from a central coordinate provided by aroundLatLng.

exhaustive

object

Whether certain properties of the search response are calculated exhaustive (exact) or approximated.

Show child attributes

exhaustive.facetsCount

boolean

Whether the facet count is exhaustive (true) or approximate (false). See the related discussion.

exhaustive.facetValues

boolean

The value is false if not all facet values are retrieved.

exhaustive.nbHits

boolean

Whether the nbHits is exhaustive (true) or approximate (false). When the query takes more than 50ms to be processed, the engine makes an approximation. This can happen when using complex filters on millions of records, when typo-tolerance was not exhaustive, or when enough hits have been retrieved (for example, after the engine finds 10,000 exact matches). nbHits is reported as non-exhaustive whenever an approximation is made, even if the approximation didn’t, in the end, impact the exhaustivity of the query.

exhaustive.rulesMatch

boolean

Rules matching exhaustivity. The value is false if rules were enable for this query, and could not be fully processed due a timeout. This is generally caused by the number of alternatives (such as typos) which is too large.

exhaustive.typo

boolean

Whether the typo search was exhaustive (true) or approximate (false). An approximation is done when the typo search query part takes more than 10% of the query budget (ie. 5ms by default) to be processed (this can happen when a lot of typo alternatives exist for the query). This field will not be included when typo-tolerance is entirely disabled.

exhaustiveFacetsCount

boolean

deprecated

See the facetsCount field of the exhaustive object in the response.

exhaustiveNbHits

boolean

deprecated

See the nbHits field of the exhaustive object in the response.

exhaustiveTypo

boolean

deprecated

See the typo field of the exhaustive object in the response.

facets

object

Facet counts.

Show child attributes

facets.{key}

object

Show child attributes

facets.{key}.{key}

integer

facets_stats

object

Statistics for numerical facets.

Show child attributes

facets_stats.{key}

object

Show child attributes

facets_stats.{key}.min

number

Minimum value in the results.

facets_stats.{key}.max

number

Maximum value in the results.

facets_stats.{key}.avg

number

Average facet value in the results.

facets_stats.{key}.sum

number

Sum of all values in the results.

index

string

Index name used for the query.

indexUsed

string

Index name used for the query. During A/B testing, the targeted index isn't always the index used by the query.

message

string

Warnings about the query.

nbSortedHits

integer

Number of hits selected and sorted by the relevant sort algorithm.

parsedQuery

string

Post-normalization query string that will be searched.

processingTimingsMS

object

Experimental. List of processing steps and their times, in milliseconds. You can use this list to investigate performance issues.

queryAfterRemoval

string

Markup text indicating which parts of the original query have been removed to retrieve a non-empty result set.

redirect

object

Redirect results to a URL, this this parameter is for internal use only.

Show child attributes

redirect.index

object[]

Show child attributes

redirect.index.source

string

required

Source index for the redirect rule.

redirect.index.dest

string

required

Destination index for the redirect rule.

redirect.index.reason

string

required

Reason for the redirect rule.

redirect.index.succeed

boolean

required

Redirect rule status.

redirect.index.data

object

required

Redirect rule data.

Show child attributes

redirect.index.data.ruleObjectID

string

required

renderingContent

object

Extra data that can be used in the search UI.

You can use this to control aspects of your search UI, such as, the order of facet names and values without changing your frontend code.

Show child attributes

renderingContent.facetOrdering

object

Order of facet names and facet values in your UI.

Show child attributes

renderingContent.facetOrdering.facets

object

Order of facet names.

Show child attributes

renderingContent.facetOrdering.facets.order

string[]

Explicit order of facets or facet values.

This setting lets you always show specific facets or facet values at the top of the list.

renderingContent.facetOrdering.values

object

Order of facet values. One object for each facet.

Show child attributes

renderingContent.facetOrdering.values.{key}

object

Show child attributes

renderingContent.facetOrdering.values.{key}.order

string[]

Explicit order of facets or facet values.

This setting lets you always show specific facets or facet values at the top of the list.

renderingContent.facetOrdering.values.{key}.sortRemainingBy

enum<string>

Order of facet values that aren't explicitly positioned with the order setting.

• count. Order remaining facet values by decreasing count. The count is the number of matching records containing this facet value.

• alpha. Sort facet values alphabetically.

• hidden. Don't show facet values that aren't explicitly positioned.

Available options:

count,

alpha,

hidden

renderingContent.facetOrdering.values.{key}.hide

string[]

Hide facet values.

renderingContent.redirect

object

The redirect rule container.

Show child attributes

renderingContent.redirect.url

string

serverTimeMS

integer

Time the server took to process the request, in milliseconds.

serverUsed

string

Host name of the server that processed the request.

userData

object

An object with custom data.

You can store up to 32kB as custom data.

queryID

string

Unique identifier for the query. This is used for click analytics.