API Reference / API Parameters / paginationLimitedTo

paginationLimitedTo

Type: integer
Engine default: 1000
Parameter syntax
'paginationLimitedTo' => number_of_records

Can be used in these methods:

About this parameter

Set the maximum number of hits accessible via pagination.

We set the maximum number of hits the pagination can possibly retrieve. For example, if set to 1000, you can’t retrieve result 1001 or higher using the pagination.

Works with the page and hitsPerPage settings to establish the full pagination logic.

Usage notes:

  • This must be set at indexing time, to define a default.

  • By default, this parameter is set to 1000 to guarantee good performance.

  • We recommend that you keep the default value to guarantee excellent performance. Increasing the pagination limit will have a direct impact on the performance of search queries. A too high value will also make it very easy for anyone to retrieve (“scrape”) your entire dataset.

Examples

Set pagination limit

1
2
3
$index->setSettings([
  'paginationLimitedTo' => 1000
]);

Did you find this page helpful?