Skip to main content

Algolia

info

We are currently working on a UI for Destinations. This means that you'll soon be able to setup Algolia directly from the Enterspeed APP yourself. But note, the Algolia destination itself is fully ready for production.

For now, contact us if you want to get started.

The Enterspeed Algolia integration uses the destinations field to send data from views directly to a configured Algolia index. This means that you can decide on the schema level which views you want to send to Algolia.

You will only have to set the destination field on the entity schema you want to send to Algolia. All schema references are automatically resolved so you don't have to set it on all referenced schemas.

It's possible to configure multiple Algolia destinations if you need to push different types of data to different Algolia indexes.

Configuration

In order to setup the Algolia configuration you need the following:

SettingDescription
Algolia Index NameThe name of the Algolia index you want to integrate to
Algolia Application IDThe unique application identifier used to identify you when working with Algolia's API
Algolia API KeyThe API key needs addObject and deleteObject rights for the index you want to integrate to
Enterspeed Environment Client API KeyThe API key for an Enterspeed Environment client. This is used to fetch the view that will be inserted into Algolia

Options

Table of available options, that you can optionally specify, if needed for your use case.

SettingDescription
objectIdBy default Enterspeed uses view id as the value for object id in Algolia. You can override default object id by providing value for this option.
indexNameOption to override what index must be used for current view. By default IndexName of Algolia configuration is used.

Example of usage

Algolia specific properties

_geoloc

_geoloc is a special property in Algolia used for doing geo-searching. See Algolia documentation

As stated in the Algolia documentation, the lat and lng properties must be numeric values. This means that you will need to make sure that your Enterspeed schema is mapping these properties as numeric values and not as strings.