Api clients / JavaScript / V3 / Methods

Export Synonyms | JavaScript API Client V3 (Deprecated)

Deprecated content
This documentation is for a deprecated version of JavaScript API client. Some features and settings may be missing or their usage may have changed. Refer to the documentation for the latest version of JavaScript API client for up-to-date information.
Required API Key: any key with the settings ACL
Method signature
index.exportSynonyms()

About this method

Retrieve an index’s complete list of synonyms.

The list includes all synonyms - whether created on the dashboard or pushed by the API.

The method returns an iterator.

Examples

1
2
3
4
5
$iterator = $index->browseSynonyms();

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

Parameters

indexName
type: string
only needed in go, scala, c#

Index name.

Response

Returns a synonym iterator.

Did you find this page helpful?