Add default search parameters with rules

You can create rules to add default parameters to every search made to the associated . This is most useful when applied with a validity period. If you want to add always active parameters for an indefinite period of time, change your index’s settings. This page shows you how to create a rule that sets:

The aroundRadius search parameter, for all queries, to 1,000 meters.
The validity period of this rule to one month.

This is an example of a conditionless rule.

Using the API

To run the code examples on this page, install the latest API client. To create a rule with one of the API clients, use the saveRule method using a rule object without a condition.

var response = await client.SaveRuleAsync(
  "INDEX_NAME",
  "a-rule-id",
  new Rule
  {
    ObjectID = "a-rule-id",
    Consequence = new Consequence
    {
      Params = new ConsequenceParams { AroundRadius = new AroundRadius(1000) },
    },
    Validity = new List<TimeRange>
    {
      new TimeRange { From = 1577836800L, Until = 1577836800L },
    },
  }
);

final response = await client.saveRule(
  indexName: "INDEX_NAME",
  objectID: "a-rule-id",
  rule: Rule(
    objectID: "a-rule-id",
    consequence: Consequence(
      params: ConsequenceParams(
        aroundRadius: 1000,
      ),
    ),
    validity: [
      TimeRange(
        from: 1577836800,
        until: 1577836800,
      ),
    ],
  ),
);

response, err := client.SaveRule(client.NewApiSaveRuleRequest(
  "INDEX_NAME", "a-rule-id",
  search.NewEmptyRule().SetObjectID("a-rule-id").SetConsequence(
    search.NewEmptyConsequence().SetParams(
      search.NewEmptyConsequenceParams().SetAroundRadius(search.Int32AsAroundRadius(1000)))).SetValidity(
    []search.TimeRange{*search.NewEmptyTimeRange().SetFrom(1577836800).SetUntil(1577836800)})))
if err != nil {
  // handle the eventual error
  panic(err)
}

UpdatedAtResponse response = client.saveRule(
  "INDEX_NAME",
  "a-rule-id",
  new Rule()
    .setObjectID("a-rule-id")
    .setConsequence(new Consequence().setParams(new ConsequenceParams().setAroundRadius(AroundRadius.of(1000))))
    .setValidity(Arrays.asList(new TimeRange().setFrom(1577836800L).setUntil(1577836800L)))
);

const response = await client.saveRule({
  indexName: 'indexName',
  objectID: 'a-rule-id',
  rule: {
    objectID: 'a-rule-id',
    consequence: { params: { aroundRadius: 1000 } },
    validity: [{ from: 1577836800, until: 1577836800 }],
  },
});

var response =
  client.saveRule(
    indexName = "INDEX_NAME",
    objectID = "a-rule-id",
    rule =
      Rule(
        objectID = "a-rule-id",
        consequence =
          Consequence(params = ConsequenceParams(aroundRadius = AroundRadius.of(1000))),
        validity = listOf(TimeRange(from = 1577836800L, until = 1577836800L)),
      ),
  )

$response = $client->saveRule(
    'INDEX_NAME',
    'a-rule-id',
    ['objectID' => 'a-rule-id',
        'consequence' => ['params' => ['aroundRadius' => 1000,
        ],
        ],
        'validity' => [
            ['from' => 1577836800,
                'until' => 1577836800,
            ],
        ],
    ],
);

response = client.save_rule(
    index_name="INDEX_NAME",
    object_id="a-rule-id",
    rule={
        "objectID": "a-rule-id",
        "consequence": {
            "params": {
                "aroundRadius": 1000,
            },
        },
        "validity": [
            {
                "from": 1577836800,
                "until": 1577836800,
            },
        ],
    },
)

response = client.save_rule(
  "INDEX_NAME",
  "a-rule-id",
  Algolia::Search::Rule.new(
    algolia_object_id: "a-rule-id",
    consequence: Algolia::Search::Consequence.new(params: Algolia::Search::ConsequenceParams.new(around_radius: 1000)),
    validity: [Algolia::Search::TimeRange.new(from: 1577836800, _until: 1577836800)]
  )
)

val response = Await.result(
  client.saveRule(
    indexName = "INDEX_NAME",
    objectID = "a-rule-id",
    rule = Rule(
      objectID = "a-rule-id",
      consequence = Consequence(
        params = Some(
          ConsequenceParams(
            aroundRadius = Some(AroundRadius(1000))
          )
        )
      ),
      validity = Some(
        Seq(
          TimeRange(
            from = Some(1577836800L),
            until = Some(1577836800L)
          )
        )
      )
    )
  ),
  Duration(100, "sec")
)

let response = try await client.saveRule(
    indexName: "INDEX_NAME",
    objectID: "a-rule-id",
    rule: Rule(
        objectID: "a-rule-id",
        consequence: SearchConsequence(params: SearchConsequenceParams(aroundRadius: SearchAroundRadius
                .int(1000))),
        validity: [SearchTimeRange(from: Int64(1_577_836_800), until: Int64(1_577_836_800))]
    )
)

Using the dashboard

You can create this rule from the Algolia dashboard using either the Visual Editor or the Manual Editor.

Visual Editor
Manual Editor

In the Algolia dashboard, select your application and index, open Rules, and select New rule > Visual Editor.
Select Create conditionless rule and click Apply.
In Consequences, expand More consequences and select Apply search parameters. Enter { "aroundRadius": 1000 } in Value and click Apply.
Select Add a date range, set the start and end dates one month apart, and click Apply.
Click Review and Publish and review the rule. To forward the rule to replicas or other indices, select them under Copy rule to. Click Publish.

In the Algolia dashboard, select your application and index, open Rules, and select New rule > Manual Editor.
In Condition(s), remove the default condition.
In Consequence(s), click Add consequence and select Add Query Parameter. Enter { "aroundRadius": 1000 }.
In Additional Settings > Timeframe in UTC, select a time range of one month.
To forward the rule to replicas or other indices, select Copy this rule to other indices and enter their names. Save your changes.

In JSON, you must write string values inside quotation marks, and number values and booleans without quotations. For more information about JSON syntax, see Algolia records.

Search and Discovery platform

Optimization and Personalization

AI-powered experiences

Production and scale

Add default search parameters with rules

Using the API

Using the dashboard

​Using the API

​Using the dashboard

Using the API

Using the dashboard