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

We released a new version of the PHP API client in public beta. Read the beta documentation for more information.

We released a new version of the JavaScript API client in public beta. Read the beta documentation for more information.

We released a new version of the Java API client in public beta. Read the beta documentation for more information.

You’re currently reading the JavaScript API client v4 documentation. Check the migration guide to learn how to upgrade from v3 to v4. You can still access the v3 documentation.

You’re currently reading the Ruby API client v2 documentation. Check the migration guide to learn how to upgrade from v1 to v2. You can still access the v1 documentation.

Get the object/definition of a specific Rule.

Examples

Read the Algolia CLI documentation for more information.

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

Parameters

objectID
type: string
Required

The ID of the Rule to retrieve.

Response

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?