Confirmed users
245
edits
Socorro:ElasticSearch API: Difference between revisions
→API Spec: Adding optional parameters
(Adding stats section) |
(→API Spec: Adding optional parameters) |
||
| Line 37: | Line 37: | ||
HTTP request: '''GET'''<br> | HTTP request: '''GET'''<br> | ||
URI: '''/search/(''types'')/for/(''terms'')/in/(''fields'')/product/(''product'')/version/(''version'')/os/(''os_name'')/from/(''from_date'')/to/(''to_date'')/''' | URI: '''/search/(''types'')/for/(''terms'')/in/(''fields'')/product/(''product'')/version/(''version'')/os/(''os_name'')/from/(''from_date'')/to/(''to_date'')/(''optional_parameters'')''' | ||
* ''types'': Type of data we are looking into. Can be set to _all to search into all types. Several types can be specified, separated by a + symbol. | * ''types'': Type of data we are looking into. Can be set to _all to search into all types. Several types can be specified, separated by a + symbol. | ||
| Line 48: | Line 48: | ||
* ''to_date'': Search for crashes that happened before this date. | * ''to_date'': Search for crashes that happened before this date. | ||
<u>'''Optional parameters:'''</u> | |||
This request has some optional parameters that can be omitted. Any omitted parameter is not used while querying ES (meaning, there is no default value for this parameters). This parameters can be set in any order, and you can use only some of them if you want to. | |||
The complete URI is as follow: | |||
/search/(''types'')/for/(''terms'')/in/(''fields'')/product/(''product'')/version/(''version'')/os/(''os_name'')/from/(''from_date'')/to/(''to_date'')/'''branches/(''branches'')/search_mode/(''search_mode'')/reason/(''crash_reason'')/build/(''build_id'')/report_process/(''report_process'')/report_type/(''report_type'')/plugin_in/(''plugin_in'')/plugin_search_mode/(''plugin_search_mode'')/plugin_term/(''plugin_term'')''' | |||
* ''branches'': Several branches can be specified, separated by a + symbol. | |||
* ''search_mode'': Set how to search. Can be either 'is_exactly', 'contains' or 'start_with'. | |||
* ''crash_reason'': Restricts search to crashes caused by this reason. | |||
* ''build_id'': Restricts search to crashes that happened on a product with this build ID. | |||
* ''report_process'': Can be 'any', 'browser' or 'plugin'. | |||
* ''report_type'': Can be 'any', 'crash' or 'hang'. | |||
* ''plugin_in'': Search for a plugin in this field. | |||
* ''plugin_search_mode'': How to search for this plugin. | |||
* ''plugin_term'': Terms to search for. Several terms can be specified, separated by a + symbol. | |||
== Report == | == Report == | ||