Browse for records

Retrieves records from an index, up to 1,000 per request.

While searching retrieves hits (records augmented with attributes for highlighting and ranking details), browsing just returns matching records. This can be useful if you want to export your indices.

• The Analytics API doesn’t collect data when using browse.
• Records are ranked by attributes and custom ranking.
• There’s no ranking for: typo-tolerance, number of matched words, proximity, geo distance.

Browse requests automatically apply these settings:

• advancedSyntax: false
• attributesToHighlight: []
• attributesToSnippet: []
• distinct: false
• enablePersonalization: false
• enableRules: false
• facets: []
• getRankingInfo: false
• ignorePlurals: false
• optionalFilters: []
• typoTolerance: true or false (min and strict evaluate to true)

If you send these parameters with your browse requests, they’ll be ignored.

Usage

1
2
3
4
5
require "algolia"

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

response = client.browse("ALGOLIA_INDEX_NAME")