Algolia
This page describes how to use Census with Algolia.
In this guide, we will show you how to connect Algolia to Census and create your first sync.
- Have your Algolia account ready.
- Have the proper credentials to access to your data source. See our docs for each supported data source for further information:
Census needs the following information to create an Algolia connection:
- Application ID
- Admin API Key
To find these credentials in Algolia confirm you are in the correct app you want to connect with Census then navigate to the Settings page then click on the API Keys tab under Teams & Access.
- Click the Add Service button
- Select Algolia in the dropdown list
- Enter your credentials and click Connect
Here you can write SQL queries or select dbt models that contain the data you want to see in Algolia. Here are some ideas of data you should select:
- Users that can be added as "friends"
- Products that are searchable in an E-commerce app
- Locations that you have for a destination stay
Once you have created your model, click save.
Now head to the Syncs page and click the Add Sync button, which will take you to a step-by-step wizard for building a data mapping.
In the "What data do you want to sync?" section
- For the Connection, select the data warehouse you'd like to use
- For the Source, select your one of your models or connect directly to a table within your data warehouse
Next up is the "Where do you want to sync data to?" section
- Pick Algolia as the Connection
- Pick the Algolia Index you want to sync to as the Object
For the "How should changes to the source be synced?" section
- Select Update Or Create
- Pick the appropriate mapping key, it should be a field where there is a unique value for each record
Finally, select the fields you want to update in the mapper in the "Which Fields should be updated?" section
- For each field in your Algolia instance, you can choose a column from your model.
Click the Next button to see a preview of what will happen when you start the sync. You can check the "Run Sync Now" checkbox to kick off an initial sync and pick a schedule afterwards.
Now go back to Algolia and go view an object in an Index that should have been updated. If everything went well, you should see your data in Algolia.
That's it, in 5 steps, you connected Census to Algolia and made data from your warehouse searchable by users using Algolia 🎉
If you have any questions or if you have any issues getting started, please contact us via the in-app live chat in the bottom right corner or send us an email at [email protected]
Algolia stores data within collections called Indices. Your Indices in Algolia can be used as objects to sync to from Census.
Object Name | Supported? | Identifiers |
Index | ✅ | Object ID |
Behaviors | Supported? | Objects |
Update or Create | ✅ | Index |
Last modified 3mo ago