API Reference / API Parameters / query

Nov. 25, 2021

query

Type: string

Engine default: "" (returns all records)

Parameter syntax

$index->search('YourQuery');

results = index.search('YourQuery')

index.search('YourQuery')

results = index.search('YourQuery')

index.search(query: "YourQuery")

index.search(Query("YourQuery"))

index.Search(new Query("YourQuery"));

index.search(new Query("YourQuery"));

index.Search("YourQuery")

search into "YourIndex" query Query(
  query = Some("YourQuery")
)

Can be used in these methods:
search, browseObjects, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey search, browse_objects, search_for_facet_values, generate_secured_api_key, add_api_key, update_api_key search, browseObjects, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey search, browse_objects, search_for_facet_values, generate_secured_api_key, add_api_key, update_api_key search, browse, searchForFacetValues, generateSecuredApiKey, addAPIKey, updateAPIKey search, browseObjects, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey Search, Browse, SearchForFacetValues, GenerateSecuredApiKey, AddApiKey, UpdateApiKey Search, browse, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey Search, BrowseObjects, SearchForFacetValues, GenerateSecuredAPIKey, AddAPIKey, UpdateAPIKey search, browse index, search into facet values, generateSecuredApiKey, add key, update key

See code examples

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.

Examples

Search for “shirt”

Copy

1
$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.

Copy

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

Did you find this page helpful?