This page documents an earlier version of the API client. For the latest version, see Search for rules.
settings
Examples
Parameters
When specified, restricts matches to rules with a specific anchoring type.
When omitted, all anchoring types may match.
One of:
containsendsWithisstartsWith
When specified, restricts matches to rules with a specific
enabled status.
When absent (default), all rules are retrieved, regardless of their enabled status.Response
Rule objects matched by the search query (see
rule).
Highlighting is provided through the standard mechanism (_highlightResult attribute inside every returned object)Response as JSON
This section shows the JSON response returned by the API. Each API client wraps this response in language-specific objects, so the structure may vary. To view the response, use thegetLogs method.
Don’t rely on the order of properties—JSON objects don’t preserve key order.
JSON