API Reference / API Parameters / hitsPerPage

Jan. 14, 2021

hitsPerPage

Type: integer

Engine default: 20

Parameter syntax

'hitsPerPage' => number_of_hits

hitsPerPage: number_of_hits

hitsPerPage: number_of_hits

'hitsPerPage': number_of_hits

hitsPerPage = number_of_hits

hitsPerPage: Int = number_of_hits

new JSONObject().put("hitsPerPage", number_of_hits)

IndexSettings settings = new IndexSettings();
settings.HitsPerPage = number_of_hits;

.setHitsPerPage(number_of_hits)

opt.HitsPerPage(number_of_hits)

hitsPerPage = Some(number_of_hits)

Can be used in these methods:
search, setSettings, browseObjects, generateSecuredApiKey, addApiKey, updateApiKey search, set_settings, browse_objects, generate_secured_api_key, add_api_key, update_api_key search, setSettings, browseObjects, generateSecuredApiKey, addApiKey, updateApiKey search, set_settings, browse_objects, generate_secured_api_key, add_api_key, update_api_key search, setSettings, browse, generateSecuredApiKey, addAPIKey, updateAPIKey search, setSettings, browseObjects, generateSecuredApiKey, addApiKey, updateApiKey searchAsync, setSettingsAsync, browseAsync Search, SetSettings, Browse, GenerateSecuredApiKey, AddApiKey, UpdateApiKey Search, setSettings, browse, generateSecuredApiKey, addApiKey, updateApiKey Search, SetSettings, BrowseObjects, GenerateSecuredAPIKey, AddAPIKey, UpdateAPIKey search, setSettings, browse index, generateSecuredApiKey, add key, update key

See code examples

About this parameter

Set the number of hits per page.

In most cases, page/hitsPerPage is the recommended method for pagination. Check our full discussion on pagination approaches.

Usage notes:

This can be set at indexing time, as a default. And can be overridden at query time.
1000 is the maximum.

Examples

Set default number of hits per page

Copy

1
2
3
$index->setSettings([
  'hitsPerPage' => 20
]);

1
2
3
4
5
6
7
8
let settings = Settings()
  .set(\.hitsPerPage, to: 20)

index.setSettings(settings) { result in
  if case .success(let response) = result {
    print("Response: \(response)")
  }
}

Override default number of hits per page for the current search

Copy

1
2
3
$results = $index->search('query', [
  'hitsPerPage' => 10
]);

1
2
3
4
5
6
7
8
let query = Query("query")
  .set(\.hitsPerPage, to: 10)

index.search(query: query) { result in
  if case .success(let response) = result {
    print("Response: \(response)")
  }
}

Building Search UI

Building Search UI

Building Search UI

Building Search UI

Building Search UI

Building Search UI

PHP

Ruby

JavaScript

Python

Swift

Kotlin

Android

.NET

Java

Golang

Scala

InstantSearch.js

React InstantSearch

Vue InstantSearch

Angular InstantSearch

InstantSearch iOS

InstantSearch Android

Autocomplete

Crawler Configuration API

Index settings and search parameters

A full reference of API Endpoints

Rails

Symfony

Django

Laravel

Crawler

Magento 2

WordPress

Shopify

Salesforce Commerce Cloud B2C

Netlify

hitsPerPage

About this parameter

Usage notes:

Examples

Set default number of hits per page

Override default number of hits per page for the current search

Did you find this page helpful?

On this page