API Reference / API Parameters / 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 through pagination.

This parameter sets the maximum number of hits that pagination can retrieve. For example, if set to 1000, you can’t retrieve results 1001 or higher.

To implement pagination, use the page and hitsPerPage parameters.

Usage notes

  • To ensure good performance, this parameter is set to a default of 1,000.
  • Increasing the pagination limit might decrease your search performance. Set the pagination limit only as large as necessary.
  • Higher pagination limits also make it more difficult to extract (scrape) all of your data.
  • To override the default value, set the paginationLimitedTo parameter at indexing time.
  • The maximum value for this parameter is 20,000 .

Examples

Set pagination limit

1
2
3
$index->setSettings([
  'paginationLimitedTo' => 1000
]);
Did you find this page helpful?