API Reference / API Parameters / query
Type: string
Engine default: "" (returns all records)
Parameter syntax

Can be used in these methods:

About this parameter

The text used to search an index.

Usage notes

Don’t confuse a “query” with other search parameters, which you can use to further interrogate search responses.

  • If the query is empty, the search will match every record in your index.
  • Queries may be no longer than 512 characters. If a query is longer, the API will return an error.
  • You can’t apply boolean logic (AND and OR) to queries. However, on your frontend, you can combine a simple query with filters and apply boolean logic to them.


Search for “shirt”

$results = $index->search('shirt');

Return every record

When searching with an empty query, it will return every record in your index ordered by custom ranking.

$results = $index->search('');
Did you find this page helpful?