RESTful API

Scalar Parameters

  • Query parameter: q

    The q parameter specifies the query string.

  • Fetch stored fields: fetchstored

    This is a boolean parameter that specifies whether stored fields should be fetched or not.

  • Show explanation: showexplain

    This is a boolean parameter that specifies whether query explanation information should be returned in the search result.

  • Starting offset: start

    This is the offset value used for search result pagination.

  • Number of result: rows

    This parameter specifies how many results should be returned for this query.

  • Routing parameter: routeparam

    This parameter specifies the value of the field used for routing (i.e. load balancing).

  • Group-by parameter: groupby

    This parameter specifies the field name used to do the group-by operation.

Example 7.1. Scalar Parameters

  q=ipad 2&fetchstored=true&showexplain=false&start=0&rows=10
  q=linkedin&start=0&rows=10&routeparam=12345&groupby=userid

Sort Fields Parameter

  • Sort fields parameter: sort

    This parameter specifies how the search results should be sorted. The results can be sorted based on one or multiple fields, in either ascending or descending order. The value of this parameter consists of a list of comma separated strings, each of which can be one of the following values:

    • relevance: this means that the results should be sorted by scores in descending order.

    • relrev: this means that the results should be sorted by scores in ascending order.

    • doc: this means that the results should be sorted by doc ids in ascending order.

    • docrev: this means that the results should be sorted by doc ids in descending order.

    • <field-name>:<direction>: this means that the results should be sorted by field <field-name> in the direction of <direction>, which can be either asc or desc.

Example 7.2. Sort Fields Parameters

  sort=relevance
  sort=docrev
  sort=price:desc,color=asc

Query Parameters

  • Query Parameters: qparam

    This parameter specifies a list of arbitrary query parameters in the form of name-value pairs, separated by commas. Each pair is formatted as <name>:<value>.

    This parameter is commonly used to pass query-level parameters to dynamic runtime facet handlers.

Example 7.3. Query Parameters

  qparam=arg1:123,arg2:abc

Selection Parameters

  • Not-value parameter: select.<field-name>.no

    This parameter specifies what values for a field should be excluded from the search results.

  • Value parameter: select.<field-name>.val

    This parameter specifies what values for a field should be included in the search results.

  • Operator parameter: select.<field-name>.op

    This parameter specifies the operator used for selection values: and or or.

  • Property parameter: select.<field-name>.prop

    This parameter specifies the additional properties if a selection is on a field with the path type.

Example 7.4. Selection Parameters

  select.color.val=red,yellow&select.color.op=or&start=0&select.color.not=black

Facet Specification Parameters

  • Maximum count parameter: facet.<facet-name>.max

    This parameter specifies the maximum count value for a facet with name fact-name.

  • Order-by parameter: facet.<facet-name>.order

    This parameter specifies how facet values should be ordered:

    • hits: order-by hits

    • val: order-by values

  • Selection-expand parameter: facet.<facet-name>.expand

  • Minimum hits parameter: facet.<facet-name>.minhit

Example 7.5. Facet Specification Parameters

  facet.color.minhit=1&facet.color.max=3&facet.color.order=val&facet.color.expand=True