API Reference / API Parameters / hitsPerPage
Jan. 14, 2019
Type: integer
Engine default: 20
Parameter syntax
'hitsPerPage' => number_of_hits

Can be used in these methods:

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

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

Did you find this page helpful?