Search Rules | JavaScript API Client V3 (Deprecated)

This version of the JavaScript API client has been deprecated in favor of the latest version of the JavaScript API client.

Required API Key: any key with the settings ACL

Method signature

index.searchRules(
  {
    query: string,
    anchoring: string,
    context: string,
    page: integer,
    hitsPerPage: integer,
    enabled: boolean
  },
  callback
)

See code examples

About this method

Search for rules matching various criteria.

Examples

Copy

Copy
$response = $index->searchRules('something', [
  'enabled' => true
]);

Copy
index.SearchRules( new RuleQuery("query")
  {
    Anchoring = "is",
    Context = "something",
    Page = 1,
    HitsPerPage = 10
  }
);

// Asynchronous
await index.SearchRulesAsync( new RuleQuery("query")
  {
    Anchoring = "is",
    Context = "something",
    Page = 1,
    HitsPerPage = 10
  }
);

Copy
// Sync
SearchResult<Rule> results = index.searchRules(
  new RuleQuery("something")
);

// Async
CompletableFuture<SearchResult<Rule>> results = index.searchRulesAsync(
  new RuleQuery("something")
);

Copy
opts := []interface{}{
  opt.Anchoring("is"),
  opt.RuleContexts("something"),
  opt.Page(1),
  opt.HitsPerPage(10),
}

res, err := index.SearchRules("query", opts...)

Parameters

`query`	type: string default: "" Optional Full text query.
`anchoring`	type: string\|enum default: all anchoring Optional When specified, restricts matches to rules with a specific anchoring type. When omitted, all anchoring types may match. One of the following values: `is`, `startsWith`, `endsWith`, `contains`
`context`	type: string default: Any context Optional Restricts matches to contextual rules with a specific context (exact match).
`page`	type: integer default: 0 Optional Requested page (zero-based).
`hitsPerPage`	type: integer default: 20 Optional Maximum number of hits in a page. Minimum is 1, maximum is 1000.
`enabled`	type: boolean default: none Optional When specified, restricts matches to rules with a specific `enabled` status. When absent (default), all rules are retrieved, regardless of their `enabled` status.

Response

In this section we document the JSON response returned by the API. Each language will encapsulate this response inside objects specific to the language and/or the implementation. So the actual type in your language might differ from what is documented.

JSON format

Copy

        {
  "hits":[
    {
      "condition":{
        "pattern":"smartphone",
        "anchoring":"contains"
      },
      "consequence":{
        "params":{
          "filters":"category = 1"
        }
      },
      "objectID":"a-rule-id",
      "_highlightResult":{
        "condition":{
          "pattern":{
            "value":"<b>s<\/b>martphone",
            "matchLevel":"full",
            "fullyHighlighted":false,
            "matchedWords":[
              "s"
            ]
          },
          "anchoring":{
            "value":"contains",
            "matchLevel":"none",
            "matchedWords":[

            ]
          }
        },
        "consequence":{
          "params":{
            "filters":{
              "value":"category = 1",
              "matchLevel":"none",
              "matchedWords":[

              ]
            }
          }
        }
      }
    }
  ],
  "nbHits":1,
  "page":0,
  "nbPages":1
}

      

`hits`	list of rule Rule objects matched by the search query (see Rule Schema). Highlighting is provided through the standard mechanism (`_highlightResult` attribute inside every returned object)
`nbHits`	integer Total number of rules matching the query.
`page`	integer Returned page number (zero-based).
`nbPages`	integer Total number of pages.