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.

searchSpecifications #

Retrieves every specifications across indexes/collections according to the given filters.

searchSpecifications(filters, [options], callback) #

Arguments Type Description
filters JSON object Search request body, using ElasticSearch Query DSL format.
If given an empty object, matches all specifications across index/collections
options JSON object Optional parameters
callback function Callback handling the response

Options #

Option Type Description Default
from number Provide the starting offset of the request (used to paginate results) 0
queuable boolean Make this request queuable or not true
scroll string Start a scroll session, with a time to live equals to this parameter's value following the Elastisearch time format undefined
size number Provide the maximum number of results of the request (used to paginate results) 10

Usage #

Copied to clipboard!
use \Kuzzle\Kuzzle;
$filters = [
  "match_all" => [
    "boost" => 1
$options = [
  'from' => 0,
  'size' => 20
$kuzzle = new Kuzzle('localhost');
$dataCollection = $kuzzle->collection('collection', 'index');
try {
  $res = $dataCollection->searchSpecifications($filters, $options);
  foreach ($res['hits'] as $specification) {
    // Specification
  // Total specifications count
catch (ErrorException $e) {

Callback response

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