The generated API clients are a work in progress, you can also find our stable clients on the Algolia documentation.

Skip to main content
API docs by Redocly

Search API (1.0.0)

Download OpenAPI specification:Download

API powering the Search feature of Algolia.

Indices

Manage indices.

Delete index

Delete an existing index.

Authorizations:
(appIdapiKey)
path Parameters
indexName
required
string
Example: myIndexName

The index in which to perform the request.

Responses

Response samples

Content type
application/json
{
  • "taskID": 0,
  • "deletedAt": "string"
}

Retrieve settings of an index

Retrieve settings of an index.

Authorizations:
(appIdapiKey)
path Parameters
indexName
required
string
Example: myIndexName

The index in which to perform the request.

Responses

Response samples

Content type
application/json
{
  • "replicas": [ ],
  • "paginationLimitedTo": 1000,
  • "unretrievableAttributes": [ ],
  • "disableTypoToleranceOnWords": [ ],
  • "attributesToTransliterate": [
    ],
  • "camelCaseAttributes": [ ],
  • "decompoundedAttributes": { },
  • "indexLanguages": [ ],
  • "disablePrefixOnAttributes": [ ],
  • "allowCompressionOfIntegerArray": false,
  • "numericAttributesForFiltering": [ ],
  • "separatorsToIndex": "",
  • "searchableAttributes": [ ],
  • "userData": { },
  • "customNormalization": {
    },
  • "attributesForFaceting": [ ],
  • "attributesToRetrieve": [
    ],
  • "restrictSearchableAttributes": [ ],
  • "ranking": [
    ],
  • "customRanking": [ ],
  • "relevancyStrictness": 100,
  • "attributesToHighlight": [
    ],
  • "attributesToSnippet": [ ],
  • "highlightPreTag": "<em>",
  • "highlightPostTag": "</em>",
  • "snippetEllipsisText": "…",
  • "restrictHighlightAndSnippetArrays": false,
  • "hitsPerPage": 20,
  • "minWordSizefor1Typo": 4,
  • "minWordSizefor2Typos": 8,
  • "typoTolerance": true,
  • "allowTyposOnNumericTokens": true,
  • "disableTypoToleranceOnAttributes": [ ],
  • "ignorePlurals": [
    ],
  • "removeStopWords": [
    ],
  • "keepDiacriticsOnCharacters": "",
  • "queryLanguages": [ ],
  • "decompoundQuery": true,
  • "enableRules": true,
  • "enablePersonalization": false,
  • "queryType": "prefixLast",
  • "removeWordsIfNoResults": "none",
  • "advancedSyntax": false,
  • "optionalWords": [ ],
  • "disableExactOnAttributes": [ ],
  • "exactOnSingleWordQuery": "attribute",
  • "alternativesAsExact": [
    ],
  • "advancedSyntaxFeatures": [
    ],
  • "distinct": true,
  • "attributeForDistinct": "string",
  • "synonyms": true,
  • "replaceSynonymsInHighlight": false,
  • "minProximity": 1,
  • "responseFields": [ ],
  • "maxFacetHits": 10,
  • "attributeCriteriaComputedByMinProximity": false,
  • "renderingContent": {
    }
}

Update settings of an index

Update settings of an index. Only specified settings are overridden; unspecified settings are left unchanged. Specifying null for a setting resets it to its default value.

Authorizations:
(appIdapiKey)
path Parameters
indexName
required
string
Example: myIndexName

The index in which to perform the request.

query Parameters
forwardToReplicas
boolean

When true, changes are also propagated to replicas of the given indexName.

Request Body schema: application/json
replicas
Array of strings
Default: []

Creates replicas, exact copies of an index.

paginationLimitedTo
integer
Default: 1000

Set the maximum number of hits accessible via pagination.

unretrievableAttributes
Array of strings
Default: []

List of attributes that can't be retrieved at query time.

disableTypoToleranceOnWords
Array of strings
Default: []

A list of words for which you want to turn off typo tolerance.

attributesToTransliterate
Array of strings

Specify on which attributes in your index Algolia should apply Japanese transliteration to make words indexed in Katakana or Kanji searchable in Hiragana.

camelCaseAttributes
Array of strings
Default: []

List of attributes on which to do a decomposition of camel case words.

decompoundedAttributes
object
Default: {}

Specify on which attributes in your index Algolia should apply word segmentation, also known as decompounding.

indexLanguages
Array of strings
Default: []

Sets the languages at the index level for language-specific processing such as tokenization and normalization.

disablePrefixOnAttributes
Array of strings
Default: []

List of attributes on which you want to disable prefix matching.

allowCompressionOfIntegerArray
boolean
Default: false

Enables compression of large integer arrays.

numericAttributesForFiltering
Array of strings
Default: []

List of numeric attributes that can be used as numerical filters.

separatorsToIndex
string
Default: ""

Control which separators are indexed.

searchableAttributes
Array of strings
Default: []

The complete list of attributes used for searching.

userData
object (userData)
Default: {}

Lets you store custom data in your indices.

object

Overrides Algolia's default normalization.

attributesForFaceting
Array of strings
Default: []

The complete list of attributes that will be used for faceting.

attributesToRetrieve
Array of strings
Default: ["*"]

This parameter controls which attributes to retrieve and which not to retrieve.

restrictSearchableAttributes
Array of strings
Default: []

Restricts a given query to look in only a subset of your searchable attributes.

ranking
Array of strings
Default: ["typo","geo","words","filters","proximity","attribute","exact","custom"]

Controls how Algolia should sort your results.

customRanking
Array of strings
Default: []

Specifies the custom ranking criterion.

relevancyStrictness
integer
Default: 100

Controls the relevancy threshold below which less relevant results aren't included in the results.

attributesToHighlight
Array of strings

List of attributes to highlight.

attributesToSnippet
Array of strings
Default: []

List of attributes to snippet, with an optional maximum number of words to snippet.

highlightPreTag
string
Default: "<em>"

The HTML string to insert before the highlighted parts in all highlight and snippet results.

highlightPostTag
string
Default: "</em>"

The HTML string to insert after the highlighted parts in all highlight and snippet results.

snippetEllipsisText
string
Default: "…"

String used as an ellipsis indicator when a snippet is truncated.

restrictHighlightAndSnippetArrays
boolean
Default: false

Restrict highlighting and snippeting to items that matched the query.

hitsPerPage
integer (hitsPerPage)
Default: 20

Set the number of hits per page.

minWordSizefor1Typo
integer
Default: 4

Minimum number of characters a word in the query string must contain to accept matches with 1 typo.

minWordSizefor2Typos
integer
Default: 8

Minimum number of characters a word in the query string must contain to accept matches with 2 typos.

boolean or typoToleranceEnum (string) (typoTolerance)

Controls whether typo tolerance is enabled and how it is applied.

allowTyposOnNumericTokens
boolean
Default: true

Whether to allow typos on numbers ("numeric tokens") in the query string.

disableTypoToleranceOnAttributes
Array of strings
Default: []

List of attributes on which you want to disable typo tolerance.

Array of strings or boolean (ignorePlurals)

Treats singular, plurals, and other forms of declensions as matching terms. ignorePlurals is used in conjunction with the queryLanguages setting. list: language ISO codes for which ignoring plurals should be enabled. This list will override any values that you may have set in queryLanguages. true: enables the ignore plurals functionality, where singulars and plurals are considered equivalent (foot = feet). The languages supported here are either every language (this is the default, see list of languages below), or those set by queryLanguages. false: disables ignore plurals, where singulars and plurals are not considered the same for matching purposes (foot will not find feet).

Array of strings or boolean (removeStopWords)

Removes stop (common) words from the query before executing it. removeStopWords is used in conjunction with the queryLanguages setting. list: language ISO codes for which ignoring plurals should be enabled. This list will override any values that you may have set in queryLanguages. true: enables the stop word functionality, ensuring that stop words are removed from consideration in a search. The languages supported here are either every language, or those set by queryLanguages. false: disables stop word functionality, allowing stop words to be taken into account in a search.

keepDiacriticsOnCharacters
string
Default: ""

List of characters that the engine shouldn't automatically normalize.

queryLanguages
Array of strings
Default: []

Sets the languages to be used by language-specific settings and functionalities such as ignorePlurals, removeStopWords, and CJK word-detection.

decompoundQuery
boolean
Default: true

Splits compound words into their composing atoms in the query.

enableRules
boolean
Default: true

Whether Rules should be globally enabled.

enablePersonalization
boolean
Default: false

Enable the Personalization feature.

queryType
string (queryType)
Default: "prefixLast"
Enum: "prefixLast" "prefixAll" "prefixNone"

Controls if and how query words are interpreted as prefixes.

removeWordsIfNoResults
string (removeWordsIfNoResults)
Default: "none"
Enum: "none" "lastWords" "firstWords" "allOptional"

Selects a strategy to remove words from the query when it doesn't match any hits.

advancedSyntax
boolean
Default: false

Enables the advanced query syntax.

optionalWords
Array of strings
Default: []

A list of words that should be considered as optional when found in the query.

disableExactOnAttributes
Array of strings
Default: []

List of attributes on which you want to disable the exact ranking criterion.

exactOnSingleWordQuery
string (exactOnSingleWordQuery)
Default: "attribute"
Enum: "attribute" "none" "word"

Controls how the exact ranking criterion is computed when the query contains only one word.

alternativesAsExact
Array of strings (alternativesAsExact)
Default: ["ignorePlurals","singleWordSynonym"]
Items Enum: "ignorePlurals" "singleWordSynonym" "multiWordsSynonym"

List of alternatives that should be considered an exact match by the exact ranking criterion.

advancedSyntaxFeatures
Array of strings (advancedSyntaxFeatures)
Default: ["exactPhrase","excludeWords"]
Items Enum: "exactPhrase" "excludeWords"

Allows you to specify which advanced syntax features are active when ‘advancedSyntax' is enabled.

boolean or integer (distinct)

Enables de-duplication or grouping of results.

attributeForDistinct
string

Name of the de-duplication attribute to be used with the distinct feature.

synonyms
boolean
Default: true

Whether to take into account an index's synonyms for a particular search.

replaceSynonymsInHighlight
boolean
Default: false

Whether to highlight and snippet the original word that matches the synonym or the synonym itself.

minProximity
integer [ 1 .. 7 ]
Default: 1

Precision of the proximity ranking criterion.

responseFields
Array of strings
Default: []

Choose which fields to return in the API response. This parameters applies to search and browse queries.

maxFacetHits
integer (maxFacetHits) <= 100
Default: 10

Maximum number of facet hits to return during a search for facet values. For performance reasons, the maximum allowed number of returned values is 100.

attributeCriteriaComputedByMinProximity
boolean
Default: false

When attribute is ranked above proximity in your ranking formula, proximity is used to select which searchable attribute is matched in the attribute ranking stage.

object (renderingContent)

Content defining how the search interface should be rendered. Can be set via the settings for a default value and can be overridden via rules.

Responses

Request samples

Content type
application/json
{
  • "replicas": [ ],
  • "paginationLimitedTo": 1000,
  • "unretrievableAttributes": [ ],
  • "disableTypoToleranceOnWords": [ ],
  • "attributesToTransliterate": [
    ],
  • "camelCaseAttributes": [ ],
  • "decompoundedAttributes": { },
  • "indexLanguages": [ ],
  • "disablePrefixOnAttributes": [ ],
  • "allowCompressionOfIntegerArray": false,
  • "numericAttributesForFiltering": [ ],
  • "separatorsToIndex": "",
  • "searchableAttributes": [ ],
  • "userData": { },
  • "customNormalization": {
    },
  • "attributesForFaceting": [ ],
  • "attributesToRetrieve": [
    ],
  • "restrictSearchableAttributes": [ ],
  • "ranking": [
    ],
  • "customRanking": [ ],
  • "relevancyStrictness": 100,
  • "attributesToHighlight": [
    ],
  • "attributesToSnippet": [ ],
  • "highlightPreTag": "<em>",
  • "highlightPostTag": "</em>",
  • "snippetEllipsisText": "…",
  • "restrictHighlightAndSnippetArrays": false,
  • "hitsPerPage": 20,
  • "minWordSizefor1Typo": 4,
  • "minWordSizefor2Typos": 8,
  • "typoTolerance": true,
  • "allowTyposOnNumericTokens": true,
  • "disableTypoToleranceOnAttributes": [ ],
  • "ignorePlurals": [
    ],
  • "removeStopWords": [
    ],
  • "keepDiacriticsOnCharacters": "",
  • "queryLanguages": [ ],
  • "decompoundQuery": true,
  • "enableRules": true,
  • "enablePersonalization": false,
  • "queryType": "prefixLast",
  • "removeWordsIfNoResults": "none",
  • "advancedSyntax": false,
  • "optionalWords": [ ],
  • "disableExactOnAttributes": [ ],
  • "exactOnSingleWordQuery": "attribute",
  • "alternativesAsExact": [
    ],
  • "advancedSyntaxFeatures": [
    ],
  • "distinct": true,
  • "attributeForDistinct": "string",
  • "synonyms": true,
  • "replaceSynonymsInHighlight": false,
  • "minProximity": 1,
  • "responseFields": [ ],
  • "maxFacetHits": 10,
  • "attributeCriteriaComputedByMinProximity": false,
  • "renderingContent": {
    }
}

Response samples

Content type
application/json
{
  • "taskID": 0,
  • "updatedAt": "string"
}

Check the status of a task

Check the current status of a given task.

Authorizations:
(appIdapiKey)
path Parameters
indexName
required
string
Example: myIndexName

The index in which to perform the request.

taskID
required
integer <int64>
Example: 13235

Unique identifier of an task. Numeric value (up to 64bits).

Responses

Response samples

Content type
application/json
{
  • "status": "published"
}

Copy/move index

Performs a copy or a move operation on a index.

Authorizations:
(appIdapiKey)
path Parameters
indexName
required
string
Example: myIndexName

The index in which to perform the request.

Request Body schema: application/json
operation
required
string (operationType)
Enum: "move" "copy"

Type of operation to perform (move or copy).

destination
required
string (indexName)

The Algolia index name.

scope
Array of strings (scopeType)
Items Enum: "settings" "synonyms" "rules"

Scope of the data to copy. When absent, a full copy is performed. When present, only the selected scopes are copied.

Responses

Request samples

Content type
application/json
{
  • "operation": "move",
  • "destination": "products",
  • "scope": [
    ]
}

Response samples

Content type
application/json
{
  • "taskID": 0,
  • "updatedAt": "string"
}

List existing indexes

List existing indexes from an application.

Authorizations:
(appIdapiKey)
query Parameters
page
integer or null
Default: null

Requested page (zero-based). When specified, will retrieve a specific page; the page size is implicitly set to 100. When null, will retrieve all indices (no pagination).

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "nbPages": 100
}

Records

Records operations.

Add an object to the index

Add an object to the index, automatically assigning it an object ID.

Authorizations:
(appIdapiKey)
path Parameters
indexName
required
string
Example: myIndexName

The index in which to perform the request.

Request Body schema: application/json

The Algolia record.

object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "createdAt": "string",
  • "taskID": 0,
  • "objectID": "string"
}

Retrieve an object

Retrieve one object from the index.

Authorizations:
(appIdapiKey)
path Parameters
indexName
required
string
Example: myIndexName

The index in which to perform the request.

objectID
required
string
Example: 123

Unique identifier of an object.

query Parameters
attributesToRetrieve
Array of strings

List of attributes to retrieve. If not specified, all retrievable attributes are returned.

Responses

Response samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

Add or replace an object

Add or replace an object with a given object ID. If the object does not exist, it will be created. If it already exists, it will be replaced.

Authorizations:
(appIdapiKey)
path Parameters
indexName
required
string
Example: myIndexName

The index in which to perform the request.

objectID
required
string
Example: 123

Unique identifier of an object.

Request Body schema: application/json

The Algolia object.

object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "taskID": 0,
  • "updatedAt": "string",
  • "objectID": "string"
}

Delete an object

Delete an existing object.

Authorizations:
(appIdapiKey)
path Parameters
indexName
required
string
Example: myIndexName

The index in which to perform the request.

objectID
required
string
Example: 123

Unique identifier of an object.

Responses

Response samples

Content type
application/json
{
  • "taskID": 0,
  • "deletedAt": "string"
}

Delete all records matching the query

Remove all objects matching a filter (including geo filters). This method enables you to delete one or more objects based on filters (numeric, facet, tag or geo queries). It doesn't accept empty filters or a query.

Authorizations:
(appIdapiKey)
path Parameters
indexName
required
string
Example: myIndexName

The index in which to perform the request.

Request Body schema: application/json
(Array of listOfSearchFilters (Array of searchFiltersArrayString (strings) or strings)) or string (facetFilters)

Filter hits by facet value.

filters
string (filters)
Default: ""

Filter the query with numeric, facet and/or tag filters.

(Array of listOfSearchFilters (Array of searchFiltersArrayString (strings) or strings)) or string (numericFilters)

Filter on numeric attributes.

(Array of listOfSearchFilters (Array of searchFiltersArrayString (strings) or strings)) or string (tagFilters)

Filter hits by tags.

aroundLatLng
string (aroundLatLng)
Default: ""

Search for entries around a central geolocation, enabling a geo search within a circular area.

integer or aroundRadiusAll (string) (aroundRadius)

Define the maximum radius for a geo search (in meters).

insideBoundingBox
Array of numbers <double> (insideBoundingBox) [ items <double > ]

Search inside a rectangular area (in geo coordinates).

insidePolygon
Array of numbers <double> (insidePolygon) [ items <double > ]

Search inside a polygon (in geo coordinates).

Responses

Request samples

Content type
application/json
{
  • "facetFilters": [
    ],
  • "filters": "",
  • "numericFilters": [
    ],
  • "tagFilters": [
    ],
  • "aroundLatLng": "",
  • "aroundRadius": 1,
  • "insideBoundingBox": [
    ],
  • "insidePolygon": [
    ]
}

Response samples

Content type
application/json
{
  • "taskID": 0,
  • "deletedAt": "string"
}

Clear all objects from an index

Delete an index's content, but leave settings and index-specific API keys untouched.

Authorizations:
(appIdapiKey)
path Parameters
indexName
required
string
Example: myIndexName

The index in which to perform the request.

Responses

Response samples

Content type
application/json
{
  • "taskID": 0,
  • "updatedAt": "string"
}

Partially update an object

Update one or more attributes of an existing object. This method lets you update only a part of an existing object, either by adding new attributes or updating existing ones. You can partially update several objects in a single method call. If the index targeted by this operation doesn't exist yet, it's automatically created.

Authorizations:
(appIdapiKey)
path Parameters
indexName
required
string
Example: myIndexName

The index in which to perform the request.

objectID
required
string
Example: 123

Unique identifier of an object.

query Parameters
createIfNotExists
boolean
Default: true

Creates the record if it does not exist yet.

Request Body schema: application/json

Map of attribute(s) to update.

additional property
attribute (string) or builtInOperation (object) (attributeToUpdate)
One of
string (attribute)

Value of the attribute to be updated.

Responses

Request samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

Response samples

Content type
application/json
{
  • "taskID": 0,
  • "updatedAt": "string",
  • "objectID": "string"
}

Batch operations to one index

Perform multiple write operations targeting one index, in a single API call.

Authorizations:
(appIdapiKey)
path Parameters
indexName
required
string
Example: myIndexName

The index in which to perform the request.

Request Body schema: application/json
required
Array of objects (batchRequest)
Array
action
required
string (action)
Enum: "addObject" "updateObject" "partialUpdateObject" "partialUpdateObjectNoCreate" "deleteObject" "delete" "clear"

type of operation.

body
required
object

arguments to the operation (depends on the type of the operation).

Responses

Request samples

Content type
application/json
{
  • "requests": [
    ]
}

Response samples

Content type
application/json
{
  • "taskID": 0,
  • "objectIDs": [
    ]
}

Batch operations to many indices

Perform multiple write operations, potentially targeting multiple indices, in a single API call.

Authorizations:
(appIdapiKey)
Request Body schema: application/json
required
Array of objects (multipleBatchRequest)
Array
action
required
string (action)
Enum: "addObject" "updateObject" "partialUpdateObject" "partialUpdateObjectNoCreate" "deleteObject" "delete" "clear"

type of operation.

body
required
object

arguments to the operation (depends on the type of the operation).

indexName
required
string

Index to target for this operation.

Responses

Request samples

Content type
application/json
{
  • "requests": [
    ]
}

Response samples

Content type
application/json
{
  • "taskID": {
    },
  • "objectIDs": [
    ]
}

Retrieve one or more objects

Retrieve one or more objects, potentially from different indices, in a single API call.

Authorizations:
(appIdapiKey)
Request Body schema: application/json

The Algolia object.

required
Array of objects (getObjectsRequest)
Array
attributesToRetrieve
Array of strings

List of attributes to retrieve. By default, all retrievable attributes are returned.

objectID
required
string

ID of the object within that index.

indexName
required
string

name of the index containing the object.

Responses

Request samples

Content type
application/json
{
  • "requests": [
    ]
}

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Search

Perform search operations.

Search in a single index

Perform a search operation targeting one specific index.

Authorizations:
(appIdapiKey)
path Parameters
indexName
required
string
Example: myIndexName

The index in which to perform the request.

Request Body schema: application/json
One of
params
string (paramsAsString)
Default: ""

Search parameters as URL-encoded query string.

Responses

Request samples

Content type
application/json
Example
{
  • "params": ""
}

Response samples

Content type
application/json
{
  • "abTestID": 0,
  • "abTestVariantID": 0,
  • "aroundLatLng": "string",
  • "automaticRadius": "string",
  • "exhaustiveFacetsCount": true,
  • "exhaustiveNbHits": true,
  • "exhaustiveTypo": true,
  • "facets": {
    },
  • "facets_stats": {
    },
  • "hitsPerPage": 20,
  • "index": "indexName",
  • "indexUsed": "indexNameAlt",
  • "message": "string",
  • "nbHits": 20,
  • "nbPages": 1,
  • "nbSortedHits": 20,
  • "page": 0,
  • "params": "query=a&hitsPerPage=20",
  • "parsedQuery": "string",
  • "processingTimeMS": 20,
  • "query": "",
  • "queryAfterRemoval": "string",
  • "serverUsed": "string",
  • "userData": { },
  • "renderingContent": {
    },
  • "hits": [
    ]
}

Search multiple indices

Perform a search operation targeting one or many indices.

Authorizations:
(appIdapiKey)
Request Body schema: application/json

The search requests and strategy.

required
Array of (SearchForHits (searchParamsString (object) or baseSearchParams (object))) or (SearchForFacets (searchParamsString (object) or baseSearchParams (object))) (SearchQuery)
strategy
string (searchStrategy)
Enum: "none" "stopIfEnoughMatches"

Responses

Request samples

Content type
application/json
{
  • "requests": [
    ],
  • "strategy": "none"
}

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Search for values of a given facet

Search for values of a given facet, optionally restricting the returned values to those contained in objects matching other search criteria.

Authorizations:
(appIdapiKey)
path Parameters
indexName
required
string
Example: myIndexName

The index in which to perform the request.

facetName
required
string

The facet name.

Request Body schema: application/json
params
string (paramsAsString)
Default: ""

Search parameters as URL-encoded query string.

facetQuery
string (facetQuery)
Default: ""

Text to search inside the facet's values.

maxFacetHits
integer (maxFacetHits) <= 100
Default: 10

Maximum number of facet hits to return during a search for facet values. For performance reasons, the maximum allowed number of returned values is 100.

Responses

Request samples

Content type
application/json
{
  • "params": "",
  • "facetQuery": "",
  • "maxFacetHits": 10
}

Response samples

Content type
application/json
{
  • "facetHits": [
    ]
}

Retrieve all index content

This method allows you to retrieve all index content. It can retrieve up to 1,000 records per call and supports full text search and filters. For performance reasons, some features are not supported, including distinct, sorting by typos, words or geo distance. When there is more content to be browsed, the response contains a cursor field. This cursor has to be passed to the subsequent call to browse in order to get the next page of results. When the end of the index has been reached, the cursor field is absent from the response.

Authorizations:
(appIdapiKey)
path Parameters
indexName
required
string
Example: myIndexName

The index in which to perform the request.

Request Body schema: application/json
One of
params
string (paramsAsString)
Default: ""

Search parameters as URL-encoded query string.

Responses

Request samples

Content type
application/json
Example
{
  • "params": ""
}

Response samples

Content type
application/json
{
  • "abTestID": 0,
  • "abTestVariantID": 0,
  • "aroundLatLng": "string",
  • "automaticRadius": "string",
  • "exhaustiveFacetsCount": true,
  • "exhaustiveNbHits": true,
  • "exhaustiveTypo": true,
  • "facets": {
    },
  • "facets_stats": {
    },
  • "hitsPerPage": 20,
  • "index": "indexName",
  • "indexUsed": "indexNameAlt",
  • "message": "string",
  • "nbHits": 20,
  • "nbPages": 1,
  • "nbSortedHits": 20,
  • "page": 0,
  • "params": "query=a&hitsPerPage=20",
  • "parsedQuery": "string",
  • "processingTimeMS": 20,
  • "query": "",
  • "queryAfterRemoval": "string",
  • "serverUsed": "string",
  • "userData": { },
  • "renderingContent": {
    },
  • "hits": [
    ],
  • "cursor": "jMDY3M2MwM2QwMWUxMmQwYWI0ZTN"
}

Rules

Rules operations.

Get a rule

Retrieve the Rule with the specified objectID.

Authorizations:
(appIdapiKey)
path Parameters
indexName
required
string
Example: myIndexName

The index in which to perform the request.

objectID
required
string
Example: 123

Unique identifier of an object.

Responses

Response samples

Content type
application/json
{
  • "objectID": "string",
  • "conditions": [
    ],
  • "consequence": {
    },
  • "description": "string",
  • "enabled": true,
  • "validity": [
    ]
}

Save/Update a rule

Create or update the Rule with the specified objectID.

Authorizations:
(appIdapiKey)
path Parameters
indexName
required
string
Example: myIndexName

The index in which to perform the request.

objectID
required
string
Example: 123

Unique identifier of an object.

query Parameters
forwardToReplicas
boolean

When true, changes are also propagated to replicas of the given indexName.

Request Body schema: application/json
objectID
required
string (objectID)

Unique identifier of the object.

Array of objects (condition)

A list of conditions that should apply to activate a Rule. You can use up to 25 conditions per Rule.

object (consequence)

Consequence of the Rule.

description
string

This field is intended for Rule management purposes, in particular to ease searching for Rules and presenting them to human readers. It's not interpreted by the API.

enabled
boolean
Default: true

Whether the Rule is enabled. Disabled Rules remain in the index, but aren't applied at query time.

Array of objects (timeRange)

By default, Rules are permanently valid. When validity periods are specified, the Rule applies only during those periods; it's ignored the rest of the time. The list must not be empty.

Responses

Request samples

Content type
application/json
{
  • "objectID": "string",
  • "conditions": [
    ],
  • "consequence": {
    },
  • "description": "string",
  • "enabled": true,
  • "validity": [
    ]
}

Response samples

Content type
application/json
{
  • "objectID": "string",
  • "updatedAt": "string",
  • "taskID": 0
}

Delete a rule

Delete the Rule with the specified objectID.

Authorizations:
(appIdapiKey)
path Parameters
indexName
required
string
Example: myIndexName

The index in which to perform the request.

objectID
required
string
Example: 123

Unique identifier of an object.

query Parameters
forwardToReplicas
boolean

When true, changes are also propagated to replicas of the given indexName.

Responses

Response samples

Content type
application/json
{
  • "taskID": 0,
  • "updatedAt": "string"
}

Save a batch of rules

Create/update multiple rules objects at once.

Authorizations:
(appIdapiKey)
path Parameters
indexName
required
string
Example: myIndexName

The index in which to perform the request.

query Parameters
forwardToReplicas
boolean

When true, changes are also propagated to replicas of the given indexName.

clearExistingRules
boolean

When true, existing Rules are cleared before adding this batch. When false, existing Rules are kept.

Request Body schema: application/json
Array
objectID
required
string (objectID)

Unique identifier of the object.

Array of objects (condition)

A list of conditions that should apply to activate a Rule. You can use up to 25 conditions per Rule.

object (consequence)

Consequence of the Rule.

description
string

This field is intended for Rule management purposes, in particular to ease searching for Rules and presenting them to human readers. It's not interpreted by the API.

enabled
boolean
Default: true

Whether the Rule is enabled. Disabled Rules remain in the index, but aren't applied at query time.

Array of objects (timeRange)

By default, Rules are permanently valid. When validity periods are specified, the Rule applies only during those periods; it's ignored the rest of the time. The list must not be empty.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "taskID": 0,
  • "updatedAt": "string"
}

Clear Rules

Delete all Rules in the index.

Authorizations:
(appIdapiKey)
path Parameters
indexName
required
string
Example: myIndexName

The index in which to perform the request.

query Parameters
forwardToReplicas
boolean

When true, changes are also propagated to replicas of the given indexName.

Responses

Response samples

Content type
application/json
{
  • "taskID": 0,
  • "updatedAt": "string"
}

Search for rules

Search for rules matching various criteria.

Authorizations:
(appIdapiKey)
path Parameters
indexName
required
string
Example: myIndexName

The index in which to perform the request.

Request Body schema: application/json
query
string (parameters_query)
Default: ""

Full text query.

anchoring
string (anchoring)
Enum: "is" "startsWith" "endsWith" "contains"

Whether the pattern parameter must match the beginning or the end of the query string, or both, or none.

context
string

Restricts matches to contextual rules with a specific context (exact match).

page
integer (parameters_page)
Default: 0

Requested page (zero-based).

hitsPerPage
integer (parameters_hitsPerPage)
Default: 20

Maximum number of hits in a page. Minimum is 1, maximum is 1000.

enabled
boolean or null
Default: null

When specified, restricts matches to rules with a specific enabled status. When absent (default), all rules are retrieved, regardless of their enabled status.

requestOptions
Array of objects

A mapping of requestOptions to send along with the request.

Responses

Request samples

Content type
application/json
{
  • "query": "",
  • "anchoring": "is",
  • "context": "string",
  • "page": 0,
  • "hitsPerPage": 20,
  • "enabled": null,
  • "requestOptions": [
    ]
}

Response samples

Content type
application/json
{
  • "hits": [
    ],
  • "nbHits": 0,
  • "page": 0,
  • "nbPages": 0
}

Synonyms

Synonyms operations.

Get synonym

Fetch a synonym object identified by its objectID.

Authorizations:
(appIdapiKey)
path Parameters
indexName
required
string
Example: myIndexName

The index in which to perform the request.

objectID
required
string
Example: 123

Unique identifier of an object.

Responses

Response samples

Content type
application/json
{
  • "objectID": "string",
  • "type": "synonym",
  • "synonyms": [
    ],
  • "input": "string",
  • "word": "string",
  • "corrections": [
    ],
  • "placeholder": "string",
  • "replacements": [
    ]
}

Save synonym

Create a new synonym object or update the existing synonym object with the given object ID.

Authorizations:
(appIdapiKey)
path Parameters
indexName
required
string
Example: myIndexName

The index in which to perform the request.

objectID
required
string
Example: 123

Unique identifier of an object.

query Parameters
forwardToReplicas
boolean

When true, changes are also propagated to replicas of the given indexName.

Request Body schema: application/json
objectID
required
string

Unique identifier of the synonym object to be created or updated.

type
required
string (SynonymType)
Enum: "synonym" "onewaysynonym" "altcorrection1" "altcorrection2" "placeholder"

Type of the synonym object.

synonyms
Array of strings

Words or phrases to be considered equivalent.

input
string

Word or phrase to appear in query strings (for onewaysynonym).

word
string

Word or phrase to appear in query strings (for altcorrection1 and altcorrection2).

corrections
Array of strings

Words to be matched in records.

placeholder
string

Token to be put inside records.

replacements
Array of strings

List of query words that will match the token.

Responses

Request samples

Content type
application/json
{
  • "objectID": "string",
  • "type": "synonym",
  • "synonyms": [
    ],
  • "input": "string",
  • "word": "string",
  • "corrections": [
    ],
  • "placeholder": "string",
  • "replacements": [
    ]
}

Response samples

Content type
application/json
{
  • "taskID": 0,
  • "updatedAt": "string",
  • "id": "string"
}

Delete synonym

Delete a single synonyms set, identified by the given objectID.

Authorizations:
(appIdapiKey)
path Parameters
indexName
required
string
Example: myIndexName

The index in which to perform the request.

objectID
required
string
Example: 123

Unique identifier of an object.

query Parameters
forwardToReplicas
boolean

When true, changes are also propagated to replicas of the given indexName.

Responses

Response samples

Content type
application/json
{
  • "taskID": 0,
  • "deletedAt": "string"
}

Save a batch of synonyms

Create/update multiple synonym objects at once, potentially replacing the entire list of synonyms if replaceExistingSynonyms is true.

Authorizations:
(appIdapiKey)
path Parameters
indexName
required
string
Example: myIndexName

The index in which to perform the request.

query Parameters
forwardToReplicas
boolean

When true, changes are also propagated to replicas of the given indexName.

replaceExistingSynonyms
boolean

Replace all synonyms of the index with the ones sent with this request.

Request Body schema: application/json
Array
objectID
required
string

Unique identifier of the synonym object to be created or updated.

type
required
string (SynonymType)
Enum: "synonym" "onewaysynonym" "altcorrection1" "altcorrection2" "placeholder"

Type of the synonym object.

synonyms
Array of strings

Words or phrases to be considered equivalent.

input
string

Word or phrase to appear in query strings (for onewaysynonym).

word
string

Word or phrase to appear in query strings (for altcorrection1 and altcorrection2).

corrections
Array of strings

Words to be matched in records.

placeholder
string

Token to be put inside records.

replacements
Array of strings

List of query words that will match the token.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "taskID": 0,
  • "updatedAt": "string"
}

Clear all synonyms

Remove all synonyms from an index.

Authorizations:
(appIdapiKey)
path Parameters
indexName
required
string
Example: myIndexName

The index in which to perform the request.

query Parameters
forwardToReplicas
boolean

When true, changes are also propagated to replicas of the given indexName.

Responses

Response samples

Content type
application/json
{
  • "taskID": 0,
  • "updatedAt": "string"
}

Search synonyms

Search or browse all synonyms, optionally filtering them by type.

Authorizations:
(appIdapiKey)
path Parameters
indexName
required
string
Example: myIndexName

The index in which to perform the request.

query Parameters
type
string (SynonymType)
Enum: "synonym" "onewaysynonym" "altcorrection1" "altcorrection2" "placeholder"

Only search for specific types of synonyms.

page
integer or null
Default: 0

Requested page (zero-based). When specified, will retrieve a specific page; the page size is implicitly set to 100. When null, will retrieve all indices (no pagination).

hitsPerPage
integer
Default: 100

Maximum number of objects to retrieve.

Request Body schema: application/json

The body of the the searchSynonyms method.

query
string (query)
Default: ""

The text to search in the index.

Responses

Request samples

Content type
application/json
{
  • "query": ""
}

Response samples

Content type
application/json
{
  • "hits": [
    ],
  • "nbHits": 20
}

Dictionaries

Dictionaries operations.

Batch dictionary entries

Send a batch of dictionary entries.

Authorizations:
(appIdapiKey)
path Parameters
dictionaryName
required
string (dictionaryType)
Enum: "plurals" "stopwords" "compounds"

The dictionary to search in.

Request Body schema: application/json
clearExistingDictionaryEntries
boolean
Default: false

When true, start the batch by removing all the custom entries from the dictionary.

required
Array of objects (batchDictionaryEntriesRequest)

List of operations to batch. Each operation is described by an action and a body.

Responses

Request samples

Content type
application/json
{
  • "clearExistingDictionaryEntries": false,
  • "requests": [
    ]
}

Response samples

Content type
application/json
{
  • "taskID": 0,
  • "updatedAt": "string"
}

Search a dictionary entries

Search the dictionary entries.

Authorizations:
(appIdapiKey)
path Parameters
dictionaryName
required
string (dictionaryType)
Enum: "plurals" "stopwords" "compounds"

The dictionary to search in.

Request Body schema: application/json
query
required
string (query)
Default: ""

The text to search in the index.

page
integer (page)
Default: 0

Specify the page to retrieve.

hitsPerPage
integer (hitsPerPage)
Default: 20

Set the number of hits per page.

language
string (language)

Language ISO code supported by the dictionary (e.g., "en" for English).

Responses

Request samples

Content type
application/json
{
  • "query": "",
  • "page": 0,
  • "hitsPerPage": 20,
  • "language": "string"
}

Response samples

Content type
application/json
{
  • "taskID": 0,
  • "updatedAt": "string"
}

Retrieve dictionaries settings

Retrieve dictionaries settings. The API stores languages whose standard entries are disabled. Fetch settings does not return false values.

Authorizations:
(appIdapiKey)

Responses

Response samples

Content type
application/json
{
  • "disableStandardEntries": {
    }
}

Set dictionaries settings

Set dictionaries settings.

Authorizations:
(appIdapiKey)
Request Body schema: application/json
required
object (standardEntries)

Map of language ISO code supported by the dictionary (e.g., "en" for English) to a boolean value.

object or null (standardEntry)

Language ISO code.

object or null (standardEntry)

Language ISO code.

object or null (standardEntry)

Language ISO code.

Responses

Request samples

Content type
application/json
{
  • "disableStandardEntries": {
    }
}

Response samples

Content type
application/json
{
  • "taskID": 0,
  • "updatedAt": "string"
}

List available languages

List dictionaries supported per language.

Authorizations:
(appIdapiKey)

Responses

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

Api Keys

Manage your Api Keys.

List API Keys

List API keys, along with their associated rights.

Authorizations:
(appIdapiKey)

Responses

Response samples

Content type
application/json
{
  • "keys": [
    ]
}

Create an API key

Add a new API Key with specific permissions/restrictions.

Authorizations:
(appIdapiKey)
Request Body schema: application/json
acl
required
Array of strings (acl)
Default: []
Items Enum: "addObject" "analytics" "browse" "deleteObject" "deleteIndex" "editSettings" "listIndexes" "logs" "personalization" "recommendation" "search" "seeUnretrievableAttributes" "settings" "usage"

Set of permissions associated with the key.

description
string
Default: ""

A comment used to identify a key more easily in the dashboard. It is not interpreted by the API.

indexes
Array of strings
Default: []

Restrict this new API key to a list of indices or index patterns. If the list is empty, all indices are allowed.

maxHitsPerQuery
integer
Default: 0

Maximum number of hits this API key can retrieve in one query. If zero, no limit is enforced.

maxQueriesPerIPPerHour
integer
Default: 0

Maximum number of API calls per hour allowed from a given IP address or a user token.

queryParameters
string
Default: ""

URL-encoded query string. Force some query parameters to be applied for each query made with this API key.

referers
Array of strings
Default: []

Restrict this new API key to specific referers. If empty or blank, defaults to all referers.

validity
integer
Default: 0

Validity limit for this key in seconds. The key will automatically be removed after this period of time.

Responses

Request samples

Content type
application/json
{
  • "acl": [ ],
  • "description": "",
  • "indexes": [ ],
  • "maxHitsPerQuery": 0,
  • "maxQueriesPerIPPerHour": 0,
  • "queryParameters": "",
  • "referers": [ ],
  • "validity": 0
}

Response samples

Content type
application/json
{
  • "key": "string",
  • "createdAt": "string"
}

Get an API key

Get the permissions of an API key.

Authorizations:
(appIdapiKey)
path Parameters
key
required
string
Example: myAPIKey

API Key string.

Responses

Response samples

Content type
application/json
{
  • "value": "string",
  • "createdAt": 0,
  • "acl": [ ],
  • "description": "",
  • "indexes": [ ],
  • "maxHitsPerQuery": 0,
  • "maxQueriesPerIPPerHour": 0,
  • "queryParameters": "",
  • "referers": [ ],
  • "validity": 0
}

Update an API key

Replace every permission of an existing API key.

Authorizations:
(appIdapiKey)
path Parameters
key
required
string
Example: myAPIKey

API Key string.

Request Body schema: application/json
acl
required
Array of strings (acl)
Default: []
Items Enum: "addObject" "analytics" "browse" "deleteObject" "deleteIndex" "editSettings" "listIndexes" "logs" "personalization" "recommendation" "search" "seeUnretrievableAttributes" "settings" "usage"

Set of permissions associated with the key.

description
string
Default: ""

A comment used to identify a key more easily in the dashboard. It is not interpreted by the API.

indexes
Array of strings
Default: []

Restrict this new API key to a list of indices or index patterns. If the list is empty, all indices are allowed.

maxHitsPerQuery
integer
Default: 0

Maximum number of hits this API key can retrieve in one query. If zero, no limit is enforced.

maxQueriesPerIPPerHour
integer
Default: 0

Maximum number of API calls per hour allowed from a given IP address or a user token.

queryParameters
string
Default: ""

URL-encoded query string. Force some query parameters to be applied for each query made with this API key.

referers
Array of strings
Default: []

Restrict this new API key to specific referers. If empty or blank, defaults to all referers.

validity
integer
Default: 0

Validity limit for this key in seconds. The key will automatically be removed after this period of time.

Responses

Request samples

Content type
application/json
{
  • "acl": [ ],
  • "description": "",
  • "indexes": [ ],
  • "maxHitsPerQuery": 0,
  • "maxQueriesPerIPPerHour": 0,
  • "queryParameters": "",
  • "referers": [ ],
  • "validity": 0
}

Response samples

Content type
application/json
{
  • "key": "string",
  • "updatedAt": "string"
}

Delete an API key

Delete an existing API Key.

Authorizations:
(appIdapiKey)
path Parameters
key
required
string
Example: myAPIKey

API Key string.

Responses

Response samples

Content type
application/json
{
  • "deletedAt": "string"
}

Restore an API key

Restore a deleted API key, along with its associated rights.

Authorizations:
(appIdapiKey)
path Parameters
key
required
string
Example: myAPIKey

API Key string.

Responses

Response samples

Content type
application/json
{
  • "key": "string",
  • "createdAt": "string"
}

Clusters

Clusters operations.

Assign or Move userID

Assign or Move a userID to a cluster. The time it takes to migrate (move) a user is proportional to the amount of data linked to the userID. Upon success, the response is 200 OK. A successful response indicates that the operation has been taken into account, and the userID is directly usable.

Authorizations:
(appIdapiKey)
header Parameters
X-Algolia-User-ID
required
string^[a-zA-Z0-9 \-*.]+$

userID to assign.

Request Body schema: application/json
cluster
required
string (clusterName)

Name of the cluster.

Responses

Request samples

Content type
application/json
{
  • "cluster": "c11-test"
}

Response samples

Content type
application/json
{
  • "createdAt": "string"
}

List userIDs

List the userIDs assigned to a multi-clusters appID. The data returned will usually be a few seconds behind real time, because userID usage may take up to a few seconds to propagate to the different clusters. Upon success, the response is 200 OK and contains the following userIDs data.

Authorizations:
(appIdapiKey)
query Parameters
page
integer or null
Default: null

Requested page (zero-based). When specified, will retrieve a specific page; the page size is implicitly set to 100. When null, will retrieve all indices (no pagination).

hitsPerPage
integer
Default: 100

Maximum number of objects to retrieve.

Responses

Response samples

Content type
application/json
{
  • "userIDs": [
    ]
}

Batch assign userIDs

Assign multiple userIDs to a cluster. Upon success, the response is 200 OK. A successful response indicates that the operation has been taken into account, and the userIDs are directly usable.

Authorizations:
(appIdapiKey)
header Parameters
X-Algolia-User-ID
required
string^[a-zA-Z0-9 \-*.]+$

userID to assign.

Request Body schema: application/json
cluster
required
string (clusterName)

Name of the cluster.

users
required
Array of strings

userIDs to assign. Note you cannot move users with this method.

Responses

Request samples

Content type
application/json
{
  • "cluster": "c11-test",
  • "users": [
    ]
}

Response samples

Content type
application/json
{
  • "createdAt": "string"
}

Get top userID

Get the top 10 userIDs with the highest number of records per cluster. The data returned will usually be a few seconds behind real time, because userID usage may take up to a few seconds to propagate to the different clusters. Upon success, the response is 200 OK and contains the following array of userIDs and clusters.

Authorizations:
(appIdapiKey)

Responses

Response samples

Content type
application/json
{
  • "topUsers": [
    ]
}

Get userID

Returns the userID data stored in the mapping. The data returned will usually be a few seconds behind real time, because userID usage may take up to a few seconds to propagate to the different clusters. Upon success, the response is 200 OK and contains the following userID data.

Authorizations:
(appIdapiKey)
path Parameters
userID
required
string^[a-zA-Z0-9 \-*.]+$

userID to assign.

Responses

Response samples

Content type
application/json
{
  • "userID": "user1",
  • "clusterName": "c1-test",
  • "nbRecords": 42,
  • "dataSize": 0
}

Remove userID

Remove a userID and its associated data from the multi-clusters. Upon success, the response is 200 OK and a task is created to remove the userID data and mapping.

Authorizations:
(appIdapiKey)
path Parameters
userID
required
string^[a-zA-Z0-9 \-*.]+$

userID to assign.

Responses

Response samples

Content type
application/json
{
  • "deletedAt": "string"
}

List clusters

List the clusters available in a multi-clusters setup for a single appID. Upon success, the response is 200 OK and contains the following clusters.

Authorizations:
(appIdapiKey)

Responses

Response samples

Content type
application/json
{
  • "topUsers": [
    ]
}

Search userID

Search for userIDs. The data returned will usually be a few seconds behind real time, because userID usage may take up to a few seconds propagate to the different clusters. To keep updates moving quickly, the index of userIDs isn't built synchronously with the mapping. Instead, the index is built once every 12h, at the same time as the update of userID usage. For example, when you perform a modification like adding or moving a userID, the search will report an outdated value until the next rebuild of the mapping, which takes place every 12h. Upon success, the response is 200 OK and contains the following userIDs data.

Authorizations:
(appIdapiKey)
Request Body schema: application/json
query
required
string

Query to search. The search is a prefix search with typoTolerance. Use empty query to retrieve all users.

clusterName
string (clusterName)

Name of the cluster.

page
integer (page)
Default: 0

Specify the page to retrieve.

hitsPerPage
integer (hitsPerPage)
Default: 20

Set the number of hits per page.

Responses

Request samples

Content type
application/json
{
  • "query": "string",
  • "clusterName": "c11-test",
  • "page": 0,
  • "hitsPerPage": 20
}

Response samples

Content type
application/json
{
  • "hits": [
    ],
  • "nbHits": 20,
  • "page": 0,
  • "hitsPerPage": 20,
  • "updatedAt": "string"
}

Get migration status

Get the status of your clusters' migrations or user creations. Creating a large batch of users or migrating your multi-cluster may take quite some time. This method lets you retrieve the status of the migration, so you can know when it's done. Upon success, the response is 200 OK. A successful response indicates that the operation has been taken into account, and the userIDs are directly usable.

Authorizations:
(appIdapiKey)
query Parameters
getClusters
boolean

If the clusters pending mapping state should be on the response.

Responses

Response samples

Content type
application/json
{
  • "pending": true,
  • "clusters": {
    }
}

Vaults

Vault operations.

List all allowed sources

List all allowed sources.

Authorizations:
(appIdapiKey)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Replace all allowed sources

Replace all allowed sources.

Authorizations:
(appIdapiKey)
Request Body schema: application/json

The sources to allow.

Array
source
required
string

The IP range of the source.

description
string

The description of the source.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "updatedAt": "string"
}

Add a single source

Add a single source to the list of allowed sources.

Authorizations:
(appIdapiKey)
Request Body schema: application/json

The source to add.

source
required
string

The IP range of the source.

description
string

The description of the source.

Responses

Request samples

Content type
application/json
{
  • "source": "10.0.0.1/32",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "createdAt": "string"
}

Remove a single source

Remove a single source from the list of allowed sources.

Authorizations:
(appIdapiKey)
path Parameters
source
required
string
Example: 10.0.0.1/32

The IP range of the source.

Responses

Response samples

Content type
application/json
{
  • "deletedAt": "string"
}

Advanced

Advanced operations.

Return the latest log entries

Return the latest log entries.

Authorizations:
(appIdapiKey)
query Parameters
offset
integer
Default: 0

First entry to retrieve (zero-based). Log entries are sorted by decreasing date, therefore 0 designates the most recent log entry.

length
integer <= 1000
Default: 10

Maximum number of entries to retrieve. The maximum allowed value is 1000.

indexName
string or null

Index for which log entries should be retrieved. When omitted, log entries are retrieved across all indices.

type
string (logType)
Default: "all"
Enum: "all" "query" "build" "error"

Type of log entries to retrieve. When omitted, all log entries are retrieved.

Responses

Response samples

Content type
application/json
{
  • "logs": [
    ]
}

Index Settings

replicas
Array of strings
Default: []

Creates replicas, exact copies of an index.

paginationLimitedTo
integer
Default: 1000

Set the maximum number of hits accessible via pagination.

unretrievableAttributes
Array of strings
Default: []

List of attributes that can't be retrieved at query time.

disableTypoToleranceOnWords
Array of strings
Default: []

A list of words for which you want to turn off typo tolerance.

attributesToTransliterate
Array of strings

Specify on which attributes in your index Algolia should apply Japanese transliteration to make words indexed in Katakana or Kanji searchable in Hiragana.

camelCaseAttributes
Array of strings
Default: []

List of attributes on which to do a decomposition of camel case words.

decompoundedAttributes
object
Default: {}

Specify on which attributes in your index Algolia should apply word segmentation, also known as decompounding.

indexLanguages
Array of strings
Default: []

Sets the languages at the index level for language-specific processing such as tokenization and normalization.

disablePrefixOnAttributes
Array of strings
Default: []

List of attributes on which you want to disable prefix matching.

allowCompressionOfIntegerArray
boolean
Default: false

Enables compression of large integer arrays.

numericAttributesForFiltering
Array of strings
Default: []

List of numeric attributes that can be used as numerical filters.

separatorsToIndex
string
Default: ""

Control which separators are indexed.

searchableAttributes
Array of strings
Default: []

The complete list of attributes used for searching.

userData
object (userData)
Default: {}

Lets you store custom data in your indices.

object

Overrides Algolia's default normalization.

attributesForFaceting
Array of strings
Default: []

The complete list of attributes that will be used for faceting.

attributesToRetrieve
Array of strings
Default: ["*"]

This parameter controls which attributes to retrieve and which not to retrieve.

restrictSearchableAttributes
Array of strings
Default: []

Restricts a given query to look in only a subset of your searchable attributes.

ranking
Array of strings
Default: ["typo","geo","words","filters","proximity","attribute","exact","custom"]

Controls how Algolia should sort your results.

customRanking
Array of strings
Default: []

Specifies the custom ranking criterion.

relevancyStrictness
integer
Default: 100

Controls the relevancy threshold below which less relevant results aren't included in the results.

attributesToHighlight
Array of strings

List of attributes to highlight.

attributesToSnippet
Array of strings
Default: []

List of attributes to snippet, with an optional maximum number of words to snippet.

highlightPreTag
string
Default: "<em>"

The HTML string to insert before the highlighted parts in all highlight and snippet results.

highlightPostTag
string
Default: "</em>"

The HTML string to insert after the highlighted parts in all highlight and snippet results.

snippetEllipsisText
string
Default: "…"

String used as an ellipsis indicator when a snippet is truncated.

restrictHighlightAndSnippetArrays
boolean
Default: false

Restrict highlighting and snippeting to items that matched the query.

hitsPerPage
integer (hitsPerPage)
Default: 20

Set the number of hits per page.

minWordSizefor1Typo
integer
Default: 4

Minimum number of characters a word in the query string must contain to accept matches with 1 typo.

minWordSizefor2Typos
integer
Default: 8

Minimum number of characters a word in the query string must contain to accept matches with 2 typos.

boolean or typoToleranceEnum (string) (typoTolerance)

Controls whether typo tolerance is enabled and how it is applied.

allowTyposOnNumericTokens
boolean
Default: true

Whether to allow typos on numbers ("numeric tokens") in the query string.

disableTypoToleranceOnAttributes
Array of strings
Default: []

List of attributes on which you want to disable typo tolerance.

Array of strings or boolean (ignorePlurals)

Treats singular, plurals, and other forms of declensions as matching terms. ignorePlurals is used in conjunction with the queryLanguages setting. list: language ISO codes for which ignoring plurals should be enabled. This list will override any values that you may have set in queryLanguages. true: enables the ignore plurals functionality, where singulars and plurals are considered equivalent (foot = feet). The languages supported here are either every language (this is the default, see list of languages below), or those set by queryLanguages. false: disables ignore plurals, where singulars and plurals are not considered the same for matching purposes (foot will not find feet).

Array of strings or boolean (removeStopWords)

Removes stop (common) words from the query before executing it. removeStopWords is used in conjunction with the queryLanguages setting. list: language ISO codes for which ignoring plurals should be enabled. This list will override any values that you may have set in queryLanguages. true: enables the stop word functionality, ensuring that stop words are removed from consideration in a search. The languages supported here are either every language, or those set by queryLanguages. false: disables stop word functionality, allowing stop words to be taken into account in a search.

keepDiacriticsOnCharacters
string
Default: ""

List of characters that the engine shouldn't automatically normalize.

queryLanguages
Array of strings
Default: []

Sets the languages to be used by language-specific settings and functionalities such as ignorePlurals, removeStopWords, and CJK word-detection.

decompoundQuery
boolean
Default: true

Splits compound words into their composing atoms in the query.

enableRules
boolean
Default: true

Whether Rules should be globally enabled.

enablePersonalization
boolean
Default: false

Enable the Personalization feature.

queryType
string (queryType)
Default: "prefixLast"
Enum: "prefixLast" "prefixAll" "prefixNone"

Controls if and how query words are interpreted as prefixes.

removeWordsIfNoResults
string (removeWordsIfNoResults)
Default: "none"
Enum: "none" "lastWords" "firstWords" "allOptional"

Selects a strategy to remove words from the query when it doesn't match any hits.

advancedSyntax
boolean
Default: false

Enables the advanced query syntax.

optionalWords
Array of strings
Default: []

A list of words that should be considered as optional when found in the query.

disableExactOnAttributes
Array of strings
Default: []

List of attributes on which you want to disable the exact ranking criterion.

exactOnSingleWordQuery
string (exactOnSingleWordQuery)
Default: "attribute"
Enum: "attribute" "none" "word"

Controls how the exact ranking criterion is computed when the query contains only one word.

alternativesAsExact
Array of strings (alternativesAsExact)
Default: ["ignorePlurals","singleWordSynonym"]
Items Enum: "ignorePlurals" "singleWordSynonym" "multiWordsSynonym"

List of alternatives that should be considered an exact match by the exact ranking criterion.

advancedSyntaxFeatures
Array of strings (advancedSyntaxFeatures)
Default: ["exactPhrase","excludeWords"]
Items Enum: "exactPhrase" "excludeWords"

Allows you to specify which advanced syntax features are active when ‘advancedSyntax' is enabled.

boolean or integer (distinct)

Enables de-duplication or grouping of results.

attributeForDistinct
string

Name of the de-duplication attribute to be used with the distinct feature.

synonyms
boolean
Default: true

Whether to take into account an index's synonyms for a particular search.

replaceSynonymsInHighlight
boolean
Default: false

Whether to highlight and snippet the original word that matches the synonym or the synonym itself.

minProximity
integer [ 1 .. 7 ]
Default: 1

Precision of the proximity ranking criterion.

responseFields
Array of strings
Default: []

Choose which fields to return in the API response. This parameters applies to search and browse queries.

maxFacetHits
integer (maxFacetHits) <= 100
Default: 10

Maximum number of facet hits to return during a search for facet values. For performance reasons, the maximum allowed number of returned values is 100.

attributeCriteriaComputedByMinProximity
boolean
Default: false

When attribute is ranked above proximity in your ranking formula, proximity is used to select which searchable attribute is matched in the attribute ranking stage.

object (renderingContent)

Content defining how the search interface should be rendered. Can be set via the settings for a default value and can be overridden via rules.

{
  • "replicas": [ ],
  • "paginationLimitedTo": 1000,
  • "unretrievableAttributes": [ ],
  • "disableTypoToleranceOnWords": [ ],
  • "attributesToTransliterate": [
    ],
  • "camelCaseAttributes": [ ],
  • "decompoundedAttributes": { },
  • "indexLanguages": [ ],
  • "disablePrefixOnAttributes": [ ],
  • "allowCompressionOfIntegerArray": false,
  • "numericAttributesForFiltering": [ ],
  • "separatorsToIndex": "",
  • "searchableAttributes": [ ],
  • "userData": { },
  • "customNormalization": {
    },
  • "attributesForFaceting": [ ],
  • "attributesToRetrieve": [
    ],
  • "restrictSearchableAttributes": [ ],
  • "ranking": [
    ],
  • "customRanking": [ ],
  • "relevancyStrictness": 100,
  • "attributesToHighlight": [
    ],
  • "attributesToSnippet": [ ],
  • "highlightPreTag": "<em>",
  • "highlightPostTag": "</em>",
  • "snippetEllipsisText": "…",
  • "restrictHighlightAndSnippetArrays": false,
  • "hitsPerPage": 20,
  • "minWordSizefor1Typo": 4,
  • "minWordSizefor2Typos": 8,
  • "typoTolerance": true,
  • "allowTyposOnNumericTokens": true,
  • "disableTypoToleranceOnAttributes": [ ],
  • "ignorePlurals": [
    ],
  • "removeStopWords": [
    ],
  • "keepDiacriticsOnCharacters": "",
  • "queryLanguages": [ ],
  • "decompoundQuery": true,
  • "enableRules": true,
  • "enablePersonalization": false,
  • "queryType": "prefixLast",
  • "removeWordsIfNoResults": "none",
  • "advancedSyntax": false,
  • "optionalWords": [ ],
  • "disableExactOnAttributes": [ ],
  • "exactOnSingleWordQuery": "attribute",
  • "alternativesAsExact": [
    ],
  • "advancedSyntaxFeatures": [
    ],
  • "distinct": true,
  • "attributeForDistinct": "string",
  • "synonyms": true,
  • "replaceSynonymsInHighlight": false,
  • "minProximity": 1,
  • "responseFields": [ ],
  • "maxFacetHits": 10,
  • "attributeCriteriaComputedByMinProximity": false,
  • "renderingContent": {
    }
}

.