Skip to main content


Web services from /about to /webhooks

group search predicate

/groups/{group}/search/predicate [GET]


Search a single group by predicate.

The parameters used for a predicate query are predicate and defaultfield. The predicate specified must be parseable by the Lucene classic parser. See  for more info.

For details see Service: /groups/{group}/search [GET].

The predicate specification might change with different Lucene versions so this service shouldn't be used for production systems.


defaultfieldThe default field, only used with the predicate parameternostringpscontent
facetsA comma-separated list of fields to use as facetsnostrings
facetsizeThe max number of facet values to load (max 1000)nointeger10
fieldsizeMaximum number of characters allowed in a result field (max 10000)nointeger1000
pageThe current page to viewnointeger1
pagesizeHow many results does a page containnointeger100
predicateThe Lucene predicate, takes precedence over the question parameternostring
sortfieldsA comma-separated list of fields to sort the resultsnostrings


This service is restricted to guest and higher unless the group is accessible to public.


The XML response is:

  <query> ... </query>
  <facets> ... </facets>
  <results> ... </results>

For details see Service: /groups/{group}/search [GET].

Error Handling

0x1501 If there is an invalid group specified
0x1502 If there are no indexes selected
0x1503 If the predicate is not valid
0x1504 If a sort field cannot be used for sorting
0x1505 If the facet size specified is bigger than the global property for face size ( maxFacetSize)
0x1506 If a numeric field is specified as a facet
Created on , last edited on