Search an index

Searches a single index and returns matching search results (hits).

This method lets you retrieve up to 1,000 hits. If you need more, use the browse operation or increase the paginatedLimitedTo index setting.

Usage

Required ACL: search
1
2
3
4
5
6
7
8
require "algolia"

client = Algolia::SearchClient.create("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY")

response = client.search_single_index(
  "ALGOLIA_INDEX_NAME",
  Algolia::Search::SearchParamsObject.new(query: "myQuery", facet_filters: ["tags:algolia"])
)
Did you find this page helpful?
Ruby API clients v3