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

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 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# A

Set the number of hits per page for paginating the search results.

In most cases, page and hitsPerPage is the recommended method for pagination. For more information, see Paginate results.

Usage notes#

This is set at indexing time.
Setting can be overridden at query time.
1000 is the maximum.

Examples# A

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)")
  }
}

Did you find this page helpful?

hitsPerPage

About this parameter# Found an issue? Edit this parameter A Edit this parameter

Usage notes#

Examples# Found an issue? Edit this parameter A Edit this parameter

Set default number of hits per page#

Override default number of hits per page for the current search#

On this page

About this parameter# A

Examples# A