Run a Composition

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.

Path Parameters

compositionID

string

required

Unique Composition ObjectID. Composition unique identifier.

Example:

"my_composition_object_id"

Body

application/json

params

Run composition parameters as object · object

Show child attributes

params.analytics

boolean

default:true

Whether this search will be included in Analytics.

params.analyticsTags

string[]

Tags to apply to the query for segmenting analytics data.

params.aroundLatLng

string

default:""

Coordinates for the center of a circle, expressed as a comma-separated string of latitude and longitude.

Only records included within a circle around this central location are included in the results. The radius of the circle is determined by the aroundRadius and minimumAroundRadius settings. This parameter is ignored if you also specify insidePolygon or insideBoundingBox.

Example:

"40.71,-74.01"

params.aroundLatLngViaIP

boolean

default:false

Whether to obtain the coordinates from the request's IP address.

params.aroundRadius

Maximum radius for a search around a central location.

This parameter works in combination with the aroundLatLng and aroundLatLngViaIP parameters. By default, the search radius is determined automatically from the density of hits around the central location. The search radius is small if there are many hits close to the central coordinates.

Required range: x >= 1

params.aroundPrecision

default:10

Precision of a coordinate-based search in meters to group results with similar distances.

The Geo ranking criterion considers all matches within the same range of distances to be equal.

params.clickAnalytics

boolean

default:false

Whether to include a queryID attribute in the response The query ID is a unique identifier for a search query and is required for tracking click and conversion events.

params.enableABTest

boolean

default:true

Whether to enable index level A/B testing for this run request. If the composition mixes multiple indices, the A/B test is ignored.

params.enablePersonalization

boolean

default:false

Whether to enable Personalization.

params.enableReRanking

boolean

default:true

Whether this search will use Dynamic Re-Ranking This setting only has an effect if you activated Dynamic Re-Ranking for this index in the Algolia dashboard.

params.enableRules

boolean

default:true

Whether to enable composition rules.

params.facetFilters

Filter the search by facet values, so that only records with the same facet values are retrieved.

Prefer using the filters parameter, which supports all filter types and combinations with boolean operators.

[filter1, filter2] is interpreted as filter1 AND filter2.
[[filter1, filter2], filter3] is interpreted as filter1 OR filter2 AND filter3.
facet:-value is interpreted as NOT facet:value.

While it's best to avoid attributes that start with a -, you can still filter them by escaping with a backslash: facet:\-value.

Example:

[
  ["category:Book", "category:-Movie"],
  "author:John Doe"
]

params.facets

string[]

Facets for which to retrieve facet values that match the search criteria and the number of matching facet values To retrieve all facets, use the wildcard character *. To retrieve disjunctive facets lists, annotate any facets with the disjunctive modifier. For more information, see facets and disjunctive faceting for Smart Groups.

Example:

{
  "facetSpecificList": {
    "summary": "Specify which facet to retrieve with some marked as disjunctive",
    "value": [["category", "disjunctive(brand)", "price"]]
  },
  "facetAll": {
    "summary": "Retrieve all facets",
    "value": [["*"]]
  }
}

params.filters

string

Filter expression to only include items that match the filter criteria in the response.

You can use these filter expressions:

Numeric filters. <facet> <op> <number>, where <op> is one of <, <=, =, !=, >, >=.
Ranges. <facet>:<lower> TO <upper> where <lower> and <upper> are the lower and upper limits of the range (inclusive).
Facet filters. <facet>:<value> where <facet> is a facet attribute (case-sensitive) and <value> a facet value.
Tag filters. _tags:<value> or just <value> (case-sensitive).
Boolean filters. <facet>: true | false.

You can combine filters with AND, OR, and NOT operators with the following restrictions:

You can only combine filters of the same type with OR. Not supported: facet:value OR num > 3.
You can't use NOT with combinations of filters. Not supported: NOT(facet:value OR facet:value)
You can't combine conjunctions (AND) with OR. Not supported: facet:value OR (facet:value AND facet:value)

Use quotes around your filters, if the facet attribute name or facet value has spaces, keywords (OR, AND, NOT), or quotes. If a facet attribute is an array, the filter matches if it matches at least one element of the array.

For more information, see Filters.

Example:

"(category:Book OR category:Ebook) AND _tags:published"

params.getRankingInfo

boolean

default:false

Whether the run response should include detailed ranking information.

params.hitsPerPage

integer

default:20

Number of hits per page.

Required range: 1 <= x <= 1000

params.injectedItems

object

A list of extenrally injected objectID groups into from an external source.

Show child attributes

params.injectedItems.{key}

object

Show child attributes

params.injectedItems.{key}.items

externalInjection · object[]

required

Show child attributes

params.injectedItems.{key}.items.objectID

string

required

An objectID injected into an external source.

params.injectedItems.{key}.items.metadata

object

User-defined key-values that will be added to the injected item in the response. This is identical to Hits metadata defined in Composition or Composition Rule, with the benefit of being set at runtime.

Example:

{ "my-field": "my-value" }

Example:

{
  "my-group-key": [
    {
      "objectID": "my-object-1",
      "metadata": { "my-field": "my-value" }
    },
    { "objectID": "my-object-2" }
  ]
}

params.insideBoundingBox

params.insidePolygon

number<double>[][]

Coordinates of a polygon in which to search.

Polygons are defined by 3 to 10,000 points. Each point is represented by its latitude and longitude. Provide multiple polygons as nested arrays. For more information, see filtering inside polygons. This parameter is ignored if you also specify insideBoundingBox.

Required array length: 6 - 20000 elements

Example:

params.minimumAroundRadius

integer

Minimum radius (in meters) for a search around a location when aroundRadius isn't set.

Required range: x >= 1

params.naturalLanguages

enum<string>[]

ISO language codes that adjust settings that are useful for processing natural language queries (as opposed to keyword searches)

Sets removeStopWords and ignorePlurals to the list of provided languages.
Sets removeWordsIfNoResults to allOptional.
Adds a natural_language attribute to ruleContexts and analyticsTags.

ISO code for a supported language.

Available options:

af,

ar,

az,

bg,

bn,

ca,

cs,

cy,

da,

de,

el,

en,

eo,

es,

et,

eu,

fa,

fi,

fo,

fr,

ga,

gl,

he,

hi,

hu,

hy,

id,

is,

it,

ja,

ka,

kk,

ko,

ku,

ky,

lt,

lv,

mi,

mn,

mr,

ms,

mt,

nb,

nl,

no,

ns,

pl,

ps,

pt,

pt-br,

qu,

ro,

ru,

sk,

sq,

sv,

sw,

ta,

te,

th,

tl,

tn,

tr,

tt,

uk,

ur,

uz,

zh

params.numericFilters

Filter by numeric facets.

Prefer using the filters parameter, which supports all filter types and combinations with boolean operators.

You can use numeric comparison operators: <, <=, =, !=, >, >=. Comparisons are precise up to 3 decimals. You can also provide ranges: facet:<lower> TO <upper>. The range includes the lower and upper boundaries. The same combination rules apply as for facetFilters.

Example:

[
  ["inStock = 1", "deliveryDate < 1441755506"],
  "price < 1000"
]

params.optionalFilters

Filters to promote or demote records in the search results.

Optional filters work like facet filters, but they don't exclude records from the search results. Records that match the optional filter rank before records that don't match. If you're using a negative filter facet:-value, matching records rank after records that don't match.

Optional filters don't work on virtual replicas.
Optional filters are applied after sort-by attributes.
Optional filters are applied before custom ranking attributes (in the default ranking).
Optional filters don't work with numeric attributes.

Example:

["category:Book", "author:John Doe"]

params.page

integer

default:0

Page of search results to retrieve.

Required range: x >= 0

params.query

string

default:""

Search query.

params.queryLanguages

enum<string>[]

Languages for language-specific query processing steps such as plurals, stop-word removal, and word-detection dictionaries This setting sets a default list of languages used by the removeStopWords and ignorePlurals settings. This setting also sets a dictionary for word detection in the logogram-based CJK languages. To support this, you must place the CJK language first You should always specify a query language. If you don't specify an indexing language, the search engine uses all supported languages, or the languages you specified with the ignorePlurals or removeStopWords parameters. This can lead to unexpected search results. For more information, see Language-specific configuration.

ISO code for a supported language.

Available options:

af,

ar,

az,

bg,

bn,

ca,

cs,

cy,

da,

de,

el,

en,

eo,

es,

et,

eu,

fa,

fi,

fo,

fr,

ga,

gl,

he,

hi,

hu,

hy,

id,

is,

it,

ja,

ka,

kk,

ko,

ku,

ky,

lt,

lv,

mi,

mn,

mr,

ms,

mt,

nb,

nl,

no,

ns,

pl,

ps,

pt,

pt-br,

qu,

ro,

ru,

sk,

sq,

sv,

sw,

ta,

te,

th,

tl,

tn,

tr,

tt,

uk,

ur,

uz,

zh

Example:

["es"]

params.relevancyStrictness

integer

default:100

Relevancy threshold below which less relevant results aren't included in the results You can only set relevancyStrictness on virtual replica indices. Use this setting to strike a balance between the relevance and number of returned results.

Example:

90

params.ruleContexts

string[]

Assigns a rule context to the run query Rule contexts are strings that you can use to trigger matching rules.

Example:

["mobile"]

params.sortBy

string

default:""

Indicates which sorting strategy to apply for the request. The value must match one of the labels defined in the "sortingStrategy" mapping. For example, "Price (asc)", see Upsert Composition. At runtime, this label is used to look up the corresponding index or replica configured in "sortingStrategy", and the query is executed using that index instead of main's.

In addition to "sortingStrategy", this parameter is also used to apply a matching Composition Rule that contains a condition defined to trigger on "sortBy", see Composition Rules.

If no value is provided or an invalid value, no sorting strategy is applied.

Example:

"Price (asc)"

params.userToken

string

Unique pseudonymous or anonymous user identifier.

This helps with analytics and click and conversion events. For more information, see user token.

Example:

"test-user-123"

Response

results

object[]

required

Search results.

Show child attributes

results.page

integer

default:0

required

Page of search results to retrieve.

Required range: x >= 0

results.nbHits

integer

required

Number of results (hits).

Example:

20

results.nbPages

integer

required

Number of pages of results.

Example:

1

results.hitsPerPage

integer

default:20

required

Number of hits per page.

Required range: 1 <= x <= 1000

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:

"George Clooney"

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:

"George Clooney"

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._rankingInfo.composed

composedRankingInfo · object

Show child attributes

results.hits._rankingInfo.composed.{key}

compositionIdRankingInfo · object

Show child attributes

results.hits._rankingInfo.composed.{key}.index

string

required

results.hits._rankingInfo.composed.{key}.injectedItemKey

string

required

results.hits._distinctSeqID

integer

results.hits._extra

object

An object that contains the extra key-value pairs provided in the injectedItem definition.

Show child attributes

results.hits._extra._injectedItemKey

string

The key of the injectedItem that inserted this metadata.

results.query

string

default:""

required

Search query.

results.params

string

required

URL-encoded string of all search parameters.

Example:

"query=a&hitsPerPage=20"

results.compositions

resultsCompositionsInfoResponse · object

required

Show child attributes

results.compositions.{key}

resultsCompositionInfoResponse · object

Show child attributes

results.compositions.{key}.injectedItems

object[]

required

Show child attributes

results.compositions.{key}.injectedItems.key

string

required

results.compositions.{key}.injectedItems.appliedRules

resultsInjectedItemAppliedRulesInfoResponse · object[]

Show child attributes

results.compositions.{key}.injectedItems.appliedRules.objectID

string

required

Unique record identifier.

Example:

"test-record-123"

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.

compositions

object

Show child attributes

compositions.run

object[]

required

Show child attributes

compositions.run.objectID

string

required

Unique record identifier.

Example:

"test-record-123"

compositions.run.appliedRules

compositionRunAppliedRules · object[]

Show child attributes

compositions.run.appliedRules.objectID

string

required

Unique record identifier.

Example:

"test-record-123"

Composition API

Authorizations

Path Parameters

Body

Response