Query Suggestions API (0.0.1)

API powering the Query Suggestions feature of Algolia.

Authentication

appId

Security Scheme Type	API Key
Header parameter name:	X-Algolia-Application-Id

apiKey

Security Scheme Type	API Key
Header parameter name:	X-Algolia-API-Key

query-suggestions

Query Suggestions API reference

Send requests to the Algolia REST API.

This method allow you to send requests to the Algolia REST API.

Authorizations:

appIdapiKey

path Parameters

path

required

string

Example: /keys

The path of the API endpoint to target, anything after the /1 needs to be specified.

query Parameters

parameters

string

Example: parameters=?query=mySearchQuery&hitsPerPage=10

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

Responses

Response samples

200
400
402
403
404

Content type

application/json

{ }

Send requests to the Algolia REST API.

This method allow you to send requests to the Algolia REST API.

Authorizations:

appIdapiKey

path Parameters

path

required

string

Example: /keys

The path of the API endpoint to target, anything after the /1 needs to be specified.

query Parameters

parameters

string

Example: parameters=?query=mySearchQuery&hitsPerPage=10

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

Request Body schema: application/json

The parameters to send with the custom request.

object

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200
400
402
403
404

Content type

application/json

{ }

Send requests to the Algolia REST API.

This method allow you to send requests to the Algolia REST API.

Authorizations:

appIdapiKey

path Parameters

path

required

string

Example: /keys

The path of the API endpoint to target, anything after the /1 needs to be specified.

query Parameters

parameters

string

Example: parameters=?query=mySearchQuery&hitsPerPage=10

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

Request Body schema: application/json

The parameters to send with the custom request.

object

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200
400
402
403
404

Content type

application/json

{ }

Send requests to the Algolia REST API.

This method allow you to send requests to the Algolia REST API.

Authorizations:

appIdapiKey

path Parameters

path

required

string

Example: /keys

The path of the API endpoint to target, anything after the /1 needs to be specified.

query Parameters

parameters

string

Example: parameters=?query=mySearchQuery&hitsPerPage=10

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

Request Body schema: application/json

The parameters to send with the custom request.

object

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200
400
402
403
404

Content type

application/json

{ }

Create a configuration of a Query Suggestions index.

Create a configuration of a Query Suggestions index. There's a limit of 100 configurations per application.

Authorizations:

appIdapiKey

Request Body schema: application/json

required	Array of objects (SourceIndices) [ items ] List of source indices used to generate a Query Suggestions index.
languages	Array of strings De-duplicate singular and plural suggestions. For example, let's say your index contains English content, and that two suggestions “shoe” and “shoes” end up in your Query Suggestions index. If the English language is configured, only the most popular of those two suggestions would remain.
exclude	Array of strings List of words and patterns to exclude from the Query Suggestions index.
indexName required	string Index name to target.

Responses

Request samples

Payload

Content type

application/json

{"sourceIndices": [{"indexName": "string",
"analyticsTags": [ ],
"facets": [ ],
"minHits": 0,
"minLetters": 0,
"generate": "[[facetA, facetB], [facetC]]",
"external": [{"query": "string",
"count": 0
}
]
}
],
"languages": ["string"
],
"exclude": ["string"
],
"indexName": "string"
}

Response samples

Content type

application/json

{"status": 200,
"message": "Success"
}

Get all the configurations of Query Suggestions.

Get all the configurations of Query Suggestions. For each index, you get a block of JSON with a list of its configuration settings.

Authorizations:

appIdapiKey

Responses

Response samples

200
401
403
422
500

Content type

application/json

[{"indexName": "string",
"sourceIndices": [{"replicas": true,
"indexName": "string",
"analyticsTags": [ ],
"facets": [ ],
"minHits": 0,
"minLetters": 0,
"generate": "[[facetA, facetB], [facetC]]",
"external": [{"query": "string",
"count": 0
}
]
}
],
"languages": ["string"
],
"exclude": ["string"
]
}
]

Update the configuration of a Query Suggestions index.

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 (SourceIndices) [ items ] List of source indices used to generate a Query Suggestions index.
languages	Array of strings De-duplicate singular and plural suggestions. For example, let's say your index contains English content, and that two suggestions “shoe” and “shoes” end up in your Query Suggestions index. If the English language is configured, only the most popular of those two suggestions would remain.
exclude	Array of strings List of words and patterns to exclude from the Query Suggestions index.

Responses

Request samples

Payload

Content type

application/json

{"sourceIndices": [{"indexName": "string",
"analyticsTags": [ ],
"facets": [ ],
"minHits": 0,
"minLetters": 0,
"generate": "[[facetA, facetB], [facetC]]",
"external": [{"query": "string",
"count": 0
}
]
}
],
"languages": ["string"
],
"exclude": ["string"
]
}

Response samples

200
401
500

Content type

application/json

{"status": 200,
"message": "Success"
}

Delete a configuration of a Query Suggestion's index.

Delete a configuration of a Query Suggestion's index. By deleting a configuraton, you stop all updates to the underlying query suggestion index. Note that when doing this, the underlying index does not change - existing suggestions remain untouched.

Authorizations:

appIdapiKey

path Parameters

indexName

required

string

Example: myIndexName

The index in which to perform the request.

Responses

Response samples

200
401
403
500

Content type

application/json

{"status": 200,
"message": "Success"
}

Get the configuration of a single Query Suggestions 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

{"indexName": "string",
"sourceIndices": [{"replicas": true,
"indexName": "string",
"analyticsTags": [ ],
"facets": [ ],
"minHits": 0,
"minLetters": 0,
"generate": "[[facetA, facetB], [facetC]]",
"external": [{"query": "string",
"count": 0
}
]
}
],
"languages": ["string"
],
"exclude": ["string"
]
}

Get the status of a Query Suggestion's index.

Get the status of a Query Suggestion's index. The status includes whether the Query Suggestions index is currently in the process of being built, and the last build time.

Authorizations:

appIdapiKey

path Parameters

indexName

required

string

Example: myIndexName

The index in which to perform the request.

Responses

Response samples

200
401
403
500

Content type

application/json

{"indexName": "string",
"isRunning": true,
"lastBuiltAt": "string"
}

Get the log file of the last build of a single Query Suggestion index.

Authorizations:

appIdapiKey

path Parameters

indexName

required

string

Example: myIndexName

The index in which to perform the request.

Responses

Response samples

200
401
403
404
500

Content type

application/json

[{"timestamp": "string",
"level": "INFO",
"message": "string",
"contextLevel": 0
}
]