POST /1/indexes/{indexName}/browse
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:falseattributesToHighlight:[]attributesToSnippet:[]distinct:falseenablePersonalization:falseenableRules:falsefacets:[]getRankingInfo:falseignorePlurals:falseoptionalFilters:[]typoTolerance:trueorfalse(minandstrictevaluate totrue)
If you send these parameters with your browse requests, they'll be ignored.
Servers
- https://{appId}.algolia.net
- https://{appId}-1.algolianet.com
- https://{appId}-2.algolianet.com
- https://{appId}-3.algolianet.com
- https://{appId}-dsn.algolia.net
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
indexName |
String | Yes |
Name of the index on which to perform the operation. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.