page
0
'page' => page_number
Can be used in these methods:
search,
browseObjects,
generateSecuredApiKey,
addApiKey,
updateApiKey
search,
browse,
generate_secured_api_key,
add_api_key,
update_api_key
search,
browse,
generateSecuredApiKey,
addApiKey,
updateApiKey
search,
browse_objects,
generate_secured_api_key,
add_api_key,
update_api_key
search,
browse
search,
browseObjects,
generateSecuredApiKey,
addApiKey,
updateApiKey
searchAsync,
browseAsync
Search,
Browse,
GenerateSecuredApiKey,
AddApiKey,
UpdateApiKey
Search,
browse,
generateSecuredApiKey,
addApiKey,
updateApiKey
Search,
BrowseObjects,
GenerateSecuredAPIKey,
AddAPIKey,
UpdateAPIKey
search,
browse index,
generateSecuredApiKey,
add key,
update key
About this parameter
Specify the page to retrieve.
You will need to use this setting if you wish to retrieve specific pages.
Usage notes:
-
Page numbers
-
Page-numbering is based on the value of
hitsPerPage. IfhitsPerPage=20, thenpage=0will display the hits from 1 to 20,page=2will display the hits from 41 to 60. -
Page numbers are zero-based. Therefore, in order to retrieve the 10th page, you need to set
page=9.
-
-
If you send a request for a page that does not exist, or is out-of-range (i.e. when page > nbPages), we do not return an error. Instead, we return 0 results.
Examples
Access the nth page of results
1
2
3
$results = $index->search('query', [
'page' => 0
]);
