algoliasearch-scala/algoliasearch/algoliasearch.search/BrowseResponse

BrowseResponse

algoliasearch.search.BrowseResponse

case class BrowseResponse(abTestID: Option[Int], abTestVariantID: Option[Int], aroundLatLng: Option[String], automaticRadius: Option[String], exhaustive: Option[Exhaustive], exhaustiveFacetsCount: Option[Boolean], exhaustiveNbHits: Option[Boolean], exhaustiveTypo: Option[Boolean], facets: Option[Map[String, Map[String, Int]]], facetsStats: Option[Map[String, FacetsStats]], hitsPerPage: Int, index: Option[String], indexUsed: Option[String], message: Option[String], nbHits: Int, nbPages: Int, nbSortedHits: Option[Int], page: Int, parsedQuery: Option[String], processingTimeMS: Int, processingTimingsMS: Option[Any], queryAfterRemoval: Option[String], redirect: Option[Redirect], renderingContent: Option[RenderingContent], serverTimeMS: Option[Int], serverUsed: Option[String], userData: Option[Any], hits: Seq[Hit], query: String, params: String, cursor: Option[String])

BrowseResponse

Value parameters

abTestID: A/B test ID. This is only included in the response for indices that are part of an A/B test.
abTestVariantID: Variant ID. This is only included in the response for indices that are part of an A/B test.
aroundLatLng: Computed geographical location.
automaticRadius: Automatically-computed radius.
cursor: Cursor indicating the location to resume browsing from. Must match the value returned by the previous call. Pass this value to the subsequent browse call to get the next page of results. When the end of the index has been reached, cursor is absent from the response.
exhaustiveFacetsCount: See the facetsCount field of the exhaustive object in the response.
exhaustiveNbHits: See the nbHits field of the exhaustive object in the response.
exhaustiveTypo: See the typo field of the exhaustive object in the response.
facets: Mapping of each facet name to the corresponding facet counts.
facetsStats: Statistics for numerical facets.
hitsPerPage: Number of hits per page.
index: Index name used for the query.
indexUsed: Index name used for the query. During A/B testing, the targeted index isn't always the index used by the query.
message: Warnings about the query.
nbHits: Number of hits the search query matched.
nbPages: Number of pages of results for the current query.
nbSortedHits: Number of hits selected and sorted by the relevant sort algorithm.
page: Page to retrieve (the first page is 0, not 1).
params: URL-encoded string of all search parameters.
parsedQuery: Post-normalization query string that will be searched.
processingTimeMS: Time the server took to process the request, in milliseconds.
processingTimingsMS: Experimental. List of processing steps and their times, in milliseconds. You can use this list to investigate performance issues.
query: Text to search for in an index.
queryAfterRemoval: Markup text indicating which parts of the original query have been removed to retrieve a non-empty result set.
serverTimeMS: Time the server took to process the request, in milliseconds.
serverUsed: Host name of the server that processed the request.
userData: Lets you store custom data in your indices.

Attributes

Graph
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Members list

Value members

Inherited methods

Attributes

Inherited from:: Product

Attributes

Inherited from:: Product

In this article

Generated with