URI Searchedit
A search request can be executed purely using a URI by providing request parameters. Not all search options are exposed when executing a search using this mode, but it can be handy for quick "curl tests". Here is an example:
$ curl -XGET 'http://localhost:9200/twitter/tweet/_search?q=user:kimchy'
And here is a sample response:
{ "_shards":{ "total" : 5, "successful" : 5, "failed" : 0 }, "hits":{ "total" : 1, "hits" : [ { "_index" : "twitter", "_type" : "tweet", "_id" : "1", "_source" : { "user" : "kimchy", "postDate" : "2009-11-15T14:12:12", "message" : "trying out Elasticsearch" } } ] } }
Parametersedit
The parameters allowed in the URI are:
Name | Description |
---|---|
| The query string (maps to the |
| The default field to use when no field prefix is defined within the query. |
| The analyzer name to be used when analyzing the query string. |
| Should terms be automatically lowercased or
not. Defaults to |
| Should wildcard and prefix queries be analyzed or
not. Defaults to |
| The default operator to be used, can be |
| If set to true will cause format based failures (like providing text to a numeric field) to be ignored. Defaults to false. |
| For each hit, contain an explanation of how scoring of the hits was computed. |
| Set to |
| The selective stored fields of the document to return for each hit, comma delimited. Not specifying any value will cause no fields to return. |
| Sorting to perform. Can either be in the form of |
| When sorting, set to |
| A search timeout, bounding the search request to be executed within the specified time value and bail with the hits accumulated up to that point when expired. Defaults to no timeout. |
|
[experimental]
This functionality is experimental and may be changed or removed completely in a future release. The maximum number of documents to collect for
each shard, upon reaching which the query execution will terminate early.
If set, the response will have a boolean field |
| The starting from index of the hits to return. Defaults to |
| The number of hits to return. Defaults to |
| The type of the search operation to perform. Can be
|