API Reference / API Parameters / length
Jan. 14, 2019
Type: integer
Engine default: null (no offset)
Parameter syntax
'length' => number_of_records

Can be used in these methods:

About this parameter

Set the number of hits to retrieve (used only with offset).

In most cases, page/hitsPerPage is the recommended method for pagination. This setting is part of an alternative paging approach.

Similar to hitsPerPage, but works only with offset.

Usage notes:

  • 1000 is the maximum.

  • If offset is omitted, length is ignored.

  • On the other hand, if you specify offset but omit length, the number of records returned is equal to the hitsPerPage. In fact, using offset requires that you specify length as well; otherwise, it defaults to page-based pagination.

Impact on the response:

  • Page-based pagination (page / hitsPerPage):

    1
    2
    3
    4
    5
    6
    7
    
    {
      ...
      "page": 1,
      "nbPages": 20,
      "hitsPerPage": 10,
      ...
    }
    
  • With offset / length:

    1
    2
    3
    4
    5
    6
    
     {
       ...
       "offset": 5,
       "length": 10,
       ...
     }
    

Examples

Get n results

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

Did you find this page helpful?