Path parameters

• ruleset_id string Required

  The unique identifier of the query ruleset containing the rule to retrieve

• rule_id string Required

  The unique identifier of the query rule within the specified ruleset to retrieve

Responses

• 200 application/json
  Hide response attributes Show response attributes object

  • rule_id string Required
  • type string Required

    Values are pinned or exclude.

  • criteria object | array[object] Required

    One of:

    _types:QueryRuleCriteria object array-2 array[object]

    Hide attributes Show attributes

    • type string Required

      Values are global, exact, exact_fuzzy, fuzzy, prefix, suffix, contains, lt, lte, gt, gte, or always.

    • metadata string
    • values array[object]

    Hide attributes Show attributes object

    • type string Required

      Values are global, exact, exact_fuzzy, fuzzy, prefix, suffix, contains, lt, lte, gt, gte, or always.

    • metadata string
    • values array[object]
  • actions object Required
    Hide actions attributes Show actions attributes object

    • ids array[string]
    • docs array[object]
      Hide docs attributes Show docs attributes object

      • _id string Required
      • _index string Required
  • priority number