SDK PHP v3.x

You are currently looking at the documentation of a previous version of Kuzzle. We strongly recommend that you use the latest version. You can also use the version selector in the top menu.

scrollSpecifications #

Returns a JSON object containing the next page of the scroll session, and the scrollId to be used in the next scroll action.
A scroll session is always initiated by a searchSpecification action with the scroll argument.

scrollSpecifications(scrollId, [options], callback) #

Arguments Type Description
scrollId string The "scrollId" provided with the last scrollSpecifications response or from the initial searchSpecifications request
options JSON object Optional parameters
callback function Callback handling the response

Options #

Option Type Description Default
queuable boolean Make this request queuable or not true
scroll string Re-initializes the scroll session timeout to its value. If not defined, the scroll timeout is defaulted to a Kuzzle configuration undefined

Usage #

Copied to clipboard!
use \Kuzzle\Kuzzle;
$kuzzle = new Kuzzle('localhost');
$dataCollection = $kuzzle->collection('collection', 'index');
try {
  $res = $dataCollection->scrollSpecifications($scrollId, ['scroll' => '1m']);
  foreach ($res['hits'] as $specification) {
    // Specification
  // Total specifications count
catch (ErrorException $e) {

Callback response

Copied to clipboard!
  "hits": [{ "first": "specification" }, { "second": "specification" }],
  "total": 2