Siren Platform User Guide

Search request

The syntax for the body of the search request is identical to the one supported by Elasticsearch’s search API, with the additional support for the join query clause in the Query DSL.


In addition to the parameters supported by Elasticsearch’s search API, Federate’s search API introduces the following additional parameters:


A task timeout, bounding a task to be executed within the specified time value (in milliseconds) and returns with the values accumulated up to that point when expired. Defaults to no timeout (-1).


To retrieve debug information from the query planner. Defaults to false.