API Reference / API Methods / Query rules / Export rules

Feb. 26, 2019

Export Rules

Required API Key: any key with the settings ACL

Method signature

$index->browseRules()

index.export_rules

index.exportRules()

index.browse_rules()

This method is not available in mobile API clients.

Query Rules need to be configured via
the Algolia Dashboard or with one of our backend API clients.

suspend fun Index.browseRules(
    query: RuleQuery = RuleQuery(),
    requestOptions: RequestOptions? = null
): List<ResponseSearchRules>

This method is not available in mobile API clients.

Query Rules need to be configured via
the Algolia Dashboard or with one of our backend API clients.

index.BrowseRules()

index.browseRules()

index.BrowseRules()

AlgoliaSyncHelper(client).exportRules(String indexName)

See code examples

About this method

Retrieve an index’s full list of rules using an iterator.

The list contains the rule name, plus the complete details of its conditions and consequences.

The list includes all rules, whether created on the dashboard or pushed by the API.

To export rules, you will need to use an iterator.

Examples

Copy

$iterator = $index->browseRules();

foreach ($iterator as $rule) {
  var_dump($rule);
}

it, err := index.BrowseRules()
// error handling

for {
	rule, err := it.Next()
	if err != nil {
		if err == io.EOF {
			break
		}
		// error handling
	}

	fmt.Printf("%#v\n", *rule)
}

Parameters


            indexName

type: string

only needed in go, scala, c#

Index name.

Response

Returns a rule iterator.

Building Search UI

Building Search UI

Building Search UI

Building Search UI

Building Search UI

Building Search UI

PHP

Ruby

JavaScript

Python

iOS

Kotlin

Android

.NET

Java

Golang

Scala

InstantSearch.js

React InstantSearch

Vue InstantSearch

Angular InstantSearch

iOS InstantSearch

Android InstantSearch

Index settings and search parameters

A full reference of API Endpoints

Rails

Symfony

Django

Laravel

Magento 1

Magento 2

WordPress

Shopify

Export Rules

About this method

Examples

Parameters

Response

Did you find this page helpful?

On this page