API Reference / API Methods / Rules / Get Rule
Required API Key: any key with the settings ACL
Method signature
$index->getRule(string objectID)

About this method # A

Get the object/definition of a specific Rule.

Examples # A

1
$rule = $index->getRule('a-rule-id');

Parameters # A

objectID #
type: string
Required

The ID of the Rule to retrieve.

Response # A

This section shows the JSON response returned by the API. Since each language encapsulates this response inside objects specific to that language and/or implementation, the actual type in your language might differ from what’s written here. You can view the response in the logs (using the getLogs method).

JSON format#

1
2
3
4
5
6
7
8
9
10
11
12
{
  "objectID": "a-rule-id",
  "conditions": [{
    "pattern": "smartphone",
    "anchoring": "contains"
  }],
  "consequence": {
    "params": {
      "filters": "category = 1"
    }
  }
}
objectID #
string

objectID of the Rule.

condition #
list

Condition of the rule.

consequence #
list

Consequence of the rule.

Did you find this page helpful?
PHP v3