Set up a connection to Algolia

Tanisha Ray

Updated December 18, 2024 11:06

Algolia is a powerful search-as-a-service platform that offers lightning-fast and customizable search functionality for websites and applications.

Set up a connection

Setting	Instructions
Name your connection *	Enter a clear and distinguishable name. Throughout integrator.io imports and exports, you will have the option to choose this new connection. A unique identifier will prove helpful later when selecting it from a list of the connections in your account.
API type *	Select your Algolia account API type: A/B testing: Get A/B test details Analytics: Get status, search, click, conversion, and revenue analytics details Crawler: Get Crawler statistics, status, URL, and task details Ingestion: Get destinations, observability, source, and task endpoints Insights: Get events and user token details Monitoring: Get monitoring and infrastructure details Personalization: Get user profile and strategy details Query suggestions: Get query status and configuration details Search: Get search details Usage: Get index usage details
Region * (This setting is only applicable for the A/B testing, Analytics, Ingestion, Personalization, and Query suggestions API types)	Select your Algolia account region (either US or EU).
Application ID *	Enter your Algolia application ID. How to retrieve the application ID
API key *	Enter your Algolia API key. Multiple layers of protection, including AES 256 encryption, are in place to keep your API key safe. When editing this connection, you must re-enter this value each time; it is stored only when the connection is saved and never displayed as text. How to retrieve the API key
Index name *	Enter your Algolia index name. How to retrieve the index name
User ID *	Enter your user ID which can be found in the Crawler User settings.
Subdomain *	Enter your Algolia account subdomain. For example, if your URL is `https://dashboard.algolia.com/apps`, then `dashboard.algolia` is your subdomain.

Tip

This connector documentation describes only the settings shown for the Simple view. For the corresponding HTTP settings, see OAuth 2.0 universal connector documentation.

How to retrieve the application ID

Sign in to your Algolia account.
Navigate to Settings > Team and access > API keys > Your API keys.
Copy the Application ID.

How to retrieve the API key

Sign in to your Algolia account.
Navigate to Settings > Team and access > API keys > All API keys.
Click Create New API key. For more information, see Keys.
Enter the details in the required fields and select the ACL.
Click Create.
Copy the API key.

How to retrieve the index name

Sign in to your Algolia account.
Navigate to Dashboard > Search. For more information, see Index name.
Copy the Index which is next to the Application.