Get all query rulesets Added in 8.10.0

GET /_query_rules

Get summarized information about the query rulesets.

Query parameters

  • from number

    Starting offset (default: 0)

  • size number

    specifies a max number of results to get

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • count number Required
    • results array[object] Required
      Hide results attributes Show results attributes object
      • ruleset_id string Required
      • rule_total_count number Required

        The number of rules associated with this ruleset

      • rule_criteria_types_counts object Required

        A map of criteria type (e.g. exact) to the number of rules of that type

        Hide rule_criteria_types_counts attribute Show rule_criteria_types_counts attribute object
        • * number Additional properties
      • rule_type_counts object Required

        A map of rule type (e.g. pinned) to the number of rules of that type

        Hide rule_type_counts attribute Show rule_type_counts attribute object
        • * number Additional properties
GET /_query_rules 
curl \
 -X GET http://api.example.com/_query_rules
Response examples (200) 
{
  "count": 42.0,
  "results": [
    {
      "ruleset_id": "string",
      "rule_total_count": 42.0,
      "rule_criteria_types_counts": {
        "additionalProperty1": 42.0,
        "additionalProperty2": 42.0
      },
      "rule_type_counts": {
        "additionalProperty1": 42.0,
        "additionalProperty2": 42.0
      }
    }
  ]
}