Search multiple indices

Sends multiple search requests to one or more indices.

This can be useful in these cases:

• Different indices for different purposes, such as, one index for products, another one for marketing content.
• Multiple searches to the same index—for example, with different filters.

Use the helper searchForHits or searchForFacets to get the results in a more convenient format, if you already know the return type you want.

POST /1/indexes/*/queries

curl

cURL

curl --request POST \
  --url 'https://algolia_application_id.algolia.net/1/indexes/*/queries' \
  --header 'accept: application/json' \
  --header 'content-type: application/json' \
  --header 'x-algolia-api-key: ALGOLIA_API_KEY' \
  --header 'x-algolia-application-id: ALGOLIA_APPLICATION_ID' \
  --data '{"requests":[{"params":"hitsPerPage=2&getRankingInfo=1","indexName":"products","type":"default"}],"strategy":"none"}'

200

{
  "results": [
    {
      "hits": [
        {
          "objectID": "test-record-123",
          "_highlightResult": {},
          "_snippetResult": {},
          "_rankingInfo": {
            "firstMatchedWord": 1,
            "geoDistance": 1,
            "nbExactWords": 1,
            "nbTypos": 1,
            "userScore": 123,
            "filters": 1,
            "geoPrecision": 2,
            "matchedGeoLocation": {
              "lat": 123,
              "lng": 123,
              "distance": 123
            },
            "personalization": {
              "filtersScore": 123,
              "rankingScore": 123,
              "score": 123
            },
            "promoted": true,
            "proximityDistance": 1,
            "words": 2,
            "promotedByReRanking": true
          },
          "_distinctSeqID": 123
        }
      ],
      "query": "",
      "params": "query=a&hitsPerPage=20",
      "abTestID": 123,
      "abTestVariantID": 2,
      "aroundLatLng": "40.71,-74.01",
      "automaticRadius": "<string>",
      "exhaustive": {
        "facetsCount": true,
        "facetValues": true,
        "nbHits": true,
        "rulesMatch": true,
        "typo": true
      },
      "appliedRules": [
        {}
      ],
      "exhaustiveFacetsCount": true,
      "exhaustiveNbHits": true,
      "exhaustiveTypo": true,
      "facets": {
        "category": {
          "food": 1,
          "tech": 42
        }
      },
      "facets_stats": {},
      "index": "indexName",
      "indexUsed": "indexNameAlt",
      "message": "<string>",
      "nbSortedHits": 20,
      "parsedQuery": "george clo",
      "processingTimeMS": 20,
      "processingTimingsMS": {},
      "queryAfterRemoval": "<string>",
      "redirect": {
        "index": [
          {
            "source": "<string>",
            "dest": "<string>",
            "reason": "<string>",
            "succeed": true,
            "data": {
              "ruleObjectID": "<string>"
            }
          }
        ]
      },
      "renderingContent": {
        "facetOrdering": {
          "facets": {
            "order": [
              "<string>"
            ]
          },
          "values": {}
        },
        "redirect": {
          "url": "<string>"
        },
        "widgets": {
          "banners": [
            {
              "image": {
                "urls": [
                  {
                    "url": "<string>"
                  }
                ],
                "title": "<string>"
              },
              "link": {
                "url": "<string>"
              }
            }
          ]
        }
      },
      "serverTimeMS": 20,
      "serverUsed": "c2-uk-3.algolia.net",
      "userData": {
        "settingID": "f2a7b51e3503acc6a39b3784ffb84300",
        "pluginVersion": "1.6.0"
      },
      "queryID": "a00dbc80a8d13c4565a442e7e2dca80a",
      "_automaticInsights": true,
      "page": 0,
      "nbHits": 20,
      "nbPages": 1,
      "hitsPerPage": 20
    }
  ]
}

Required ACL: search

Authorizations

x-algolia-application-id · string · header · required

Your Algolia application ID.

x-algolia-api-key · string · header · required

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.

Body

application/json

Muli-search request body. Results are returned in the same order as the requests.

requests · Search parameters as query string · object · Search parameters as object · object · Search parameters as query string · object · Search parameters as object · object[] · required

Search parameters as query string.

Search parameters as query string

Show child attributes

requests. indexName · string · required

Index name (case-sensitive).

Example:

"products"

requests. params · string · default: ""

Search parameters as a URL-encoded query string.

Example:

"hitsPerPage=2&getRankingInfo=1"

requests. type · enum<string> · default: default

• default: perform a search query
• facet searches for facet values.

Available options: default

strategy · enum<string>

Strategy for multiple search queries:

• none. Run all queries.
• stopIfEnoughMatches. Run the queries one by one, stopping as soon as a query matches at least the hitsPerPage number of results.

Available options: none, stopIfEnoughMatches

Response

200

application/json

OK

results · object[] · required

Option 1

Show child attributes

results. 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

results.hits. objectID · string · required

Unique record identifier.

Example:

"test-record-123"

results.hits. _highlightResult · highlightResultMap · object

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

Show child attributes

results.hits._highlightResult. {key}

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

Show child attributes

results.hits._highlightResult.{key}. value · string · required

Highlighted attribute value, including HTML tags.

Example:

"<em>George</em> <em>Clo</em>oney"

results.hits._highlightResult.{key}. matchLevel · enum<string> · required

Whether the whole query string matches or only a part.

Available options: none, partial, full

results.hits._highlightResult.{key}. matchedWords · string[] · required

List of matched words from the search query.

Example:

["action"]

results.hits._highlightResult.{key}. fullyHighlighted · boolean

Whether the entire attribute value is highlighted.

results.hits. _snippetResult · snippetResultMap · object

Snippets that show the context around a matching search query.

Show child attributes

results.hits._snippetResult. {key}

Snippets that show the context around a matching search query.

Show child attributes

results.hits._snippetResult.{key}. value · string · required

Highlighted attribute value, including HTML tags.

Example:

"<em>George</em> <em>Clo</em>oney"

results.hits._snippetResult.{key}. matchLevel · enum<string> · required

Whether the whole query string matches or only a part.

Available options: none, partial, full

results.hits. _rankingInfo · object

Object with detailed information about the record's ranking.

Show child attributes

results.hits._rankingInfo. firstMatchedWord · integer · required

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

Required range: x >= 0

results.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

results.hits._rankingInfo. nbExactWords · integer · required

Number of exactly matched words.

Required range: x >= 0

results.hits._rankingInfo. nbTypos · integer · required

Number of typos encountered when matching the record.

Required range: x >= 0

results.hits._rankingInfo. userScore · integer · required

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

results.hits._rankingInfo. filters · integer

Whether a filter matched the query.

Required range: x >= 0

results.hits._rankingInfo. geoPrecision · integer

Precision used when computing the geo distance, in meters.

Required range: x >= 1

results.hits._rankingInfo. matchedGeoLocation · object

Show child attributes

results.hits._rankingInfo.matchedGeoLocation. lat · number<double>

Latitude of the matched location.

results.hits._rankingInfo.matchedGeoLocation. lng · number<double>

Longitude of the matched location.

results.hits._rankingInfo.matchedGeoLocation. distance · integer

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

results.hits._rankingInfo. personalization · object

Show child attributes

results.hits._rankingInfo.personalization. filtersScore · integer

The score of the filters.

results.hits._rankingInfo.personalization. rankingScore · integer

The score of the ranking.

results.hits._rankingInfo.personalization. score · integer

The score of the event.

results.hits._rankingInfo. promoted · boolean

Whether the record was promoted by a rule.

results.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

results.hits._rankingInfo. words · integer

Number of matched words.

Required range: x >= 1

results.hits._rankingInfo. promotedByReRanking · boolean

Whether the record is re-ranked.

results.hits. _distinctSeqID · integer

results. query · string · default: "" · required

Search query.

results. params · string · required

URL-encoded string of all search parameters.

Example:

"query=a&hitsPerPage=20"

results. abTestID · integer

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

results. 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

results. aroundLatLng · string

Computed geographical location.

Example:

"40.71,-74.01"

results. automaticRadius · string

Distance from a central coordinate provided by aroundLatLng.

results. exhaustive · exhaustive · object

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

Show child attributes

results.exhaustive. facetsCount · boolean

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

results.exhaustive. facetValues · boolean

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

results.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.

results.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.

results.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.

results. appliedRules · appliedRules · object[]

Rules applied to the query.

results. exhaustiveFacetsCount · boolean · deprecated

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

results. exhaustiveNbHits · boolean · deprecated

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

results. exhaustiveTypo · boolean · deprecated

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

results. facets · facets · object

Facet counts.

Show child attributes

results.facets. {key} · object

Show child attributes

results.facets.{key}. {key} · integer

Example:

{ "category": { "food": 1, "tech": 42 } }

results. facets_stats · object

Statistics for numerical facets.

Show child attributes

results.facets_stats. {key} · facetStats · object

Show child attributes

results.facets_stats.{key}. min · number<double>

Minimum value in the results.

results.facets_stats.{key}. max · number<double>

Maximum value in the results.

results.facets_stats.{key}. avg · number<double>

Average facet value in the results.

results.facets_stats.{key}. sum · number<double>

Sum of all values in the results.

results. index · string

Index name used for the query.

Example:

"indexName"

results. indexUsed · string

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

Example:

"indexNameAlt"

results. message · string

Warnings about the query.

results. nbSortedHits · integer

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

Example:

20

results. parsedQuery · string

Post-normalization query string that will be searched.

Example:

"george clo"

results. processingTimeMS · integer

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

Example:

20

results. processingTimingsMS · object

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

results. queryAfterRemoval · string

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

results. redirect · redirect · object

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

Show child attributes

results.redirect. index · object[]

Show child attributes

results.redirect.index. source · string · required

Source index for the redirect rule.

results.redirect.index. dest · string · required

Destination index for the redirect rule.

results.redirect.index. reason · string · required

Reason for the redirect rule.

results.redirect.index. succeed · boolean · required

Redirect rule status.

results.redirect.index. data · redirectRuleIndexData · object · required

Redirect rule data.

Show child attributes

results.redirect.index.data. ruleObjectID · string · required

results. 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

results.renderingContent. facetOrdering · object

Order of facet names and facet values in your UI.

Show child attributes

results.renderingContent.facetOrdering. facets · object

Order of facet names.

Show child attributes

results.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.

results.renderingContent.facetOrdering. values · object

Order of facet values. One object for each facet.

Show child attributes

results.renderingContent.facetOrdering.values. {key} · object

Show child attributes

results.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.

results.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

results.renderingContent.facetOrdering.values.{key}. hide · string[]

Hide facet values.

results.renderingContent. redirect · object

The redirect rule container.

Show child attributes

results.renderingContent.redirect. url · string

results.renderingContent. widgets · object

Widgets returned from any rules that are applied to the current search.

Show child attributes

results.renderingContent.widgets. banners · object[]

Banners defined in the Merchandising Studio for a given search.

Show child attributes

results.renderingContent.widgets.banners. image · object

Image to show inside a banner.

Show child attributes

results.renderingContent.widgets.banners.image. urls · object[]

Show child attributes

results.renderingContent.widgets.banners.image.urls. url · string

results.renderingContent.widgets.banners.image. title · string

results.renderingContent.widgets.banners. link · object

Link for a banner defined in the Merchandising Studio.

Show child attributes

results.renderingContent.widgets.banners.link. url · string

results. serverTimeMS · integer

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

Example:

20

results. serverUsed · string

Host name of the server that processed the request.

Example:

"c2-uk-3.algolia.net"

results. userData · any · default: {}

An object with custom data.

You can store up to 32kB as custom data.

Example:

{
  "settingID": "f2a7b51e3503acc6a39b3784ffb84300",
  "pluginVersion": "1.6.0"
}

results. queryID · string

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

Example:

"a00dbc80a8d13c4565a442e7e2dca80a"

results. _automaticInsights · boolean

Whether automatic events collection is enabled for the application.

results. page · integer · default: 0

Page of search results to retrieve.

Required range: x >= 0

results. nbHits · integer

Number of results (hits).

Example:

20

results. nbPages · integer

Number of pages of results.

Example:

1

results. hitsPerPage · integer · default: 20

Number of hits per page.

Required range: 1 <= x <= 1000