length

Number of results to retrieve in combination with offset.

• Type: integer
• Default: null
• Max: 1,000
• Scope: settings,search

The length parameter can be used with offset as an alternative approach to pagination.

Usage

• If offset is omitted, length is ignored.
• If offset is specified but length omitted, the number of records returned is equal to hitsPerPage.

With offset and length, the response includes these fields:

{
  // ...
  "offset": 5,
  "length": 10,
  // ...
}

Example

Current API clients

C#

var response = await client.SearchSingleIndexAsync<Hit>(
  "ALGOLIA_INDEX_NAME",
  new SearchParams(new SearchParamsObject { Query = "query", Length = 4 })
);

Legacy API clients

C#

index.Search(new Query("query")
{
    Length = 4
    Offset = 1
});