Articles in this section

Set up a connection to Algolia

Tanisha Ray
Updated

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

After you start the connection, configure it in the Create connection panel and complete all of the required * authentication settings:

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: Run and analyze search experiments to compare index settings and optimize user experience through data-driven decisions.

  • Analytics: Access aggregated performance and behavior data to monitor search usage and improve relevance.

  • Crawler: Automatically extract and index website content to keep your Algolia indices up to date without manual scraping.

  • Ingestion: Import data from external sources using pipelines to automate indexing workflows.

  • Insights: Track clicks, views, and conversions to power personalization, analytics, and real-time tuning.

  • Monitoring: Monitor API usage, latency, and system health to ensure search performance and reliability.

  • Personalization: Customize ranking and relevance for individual users based on behavior and user tokens.

  • Query suggestions: Generate autocomplete suggestions using past searches to improve search speed and accuracy.

  • Search: Perform fast, relevant full-text searches with support for filtering, typo tolerance, and faceting.

  • Usage: View detailed usage metrics to track API activity and manage billing.

API types: A/B testing, Personalization, Query suggestions, and Ingestion

Region *  

Select your Algolia account region (either US or EU).

Application ID * 

Enter your Algolia application ID.

dataLoad.svg​​ 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.

dataLoad.svg​​ How to retrieve the API key 

API type: Analytics

Region *  

Select your Algolia account region (either US or EU).

Application ID * 

Enter your Algolia application ID.

dataLoad.svg​​ 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.

dataLoad.svg​​ How to retrieve the API key 

Index name *  

Enter your Algolia index name.

dataLoad.svg​​ How to retrieve the index name 

API type: Crawler

User ID * 

Enter your user ID, which can be found in the Crawler User settings.

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.

dataLoad.svg​​ How to retrieve the API key 

API types: Insights, Monitoring, and Usage

Application ID * 

Enter your Algolia application ID.

dataLoad.svg​​ 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.

dataLoad.svg​​ How to retrieve the API key 

API type: Search

Subdomain * 

Enter your Algolia account subdomain. For example, if your URL is https://dashboard.algolia.com/apps, then dashboard.algolia is your subdomain.

Application ID * 

Enter your Algolia application ID.

dataLoad.svg​​ 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.

dataLoad.svg​​ How to retrieve the API key 

Tip

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

How to retrieve the application ID

  1. Sign in to your Algolia account. 

  2. Navigate to Settings > Team and access > API keys > Your API keys.

  3. Copy the Application ID.

How to retrieve the API key

  1. Sign in to your Algolia account.

  2. Navigate to Settings > Team and access > API keys > All API keys.

  3. Click Create New API key. For more information, see Keys.

  4. Enter the details in the required fields and select the ACL.

  5. Click Create.

  6. Copy the API key.

How to retrieve the index name

  1. Sign in to your Algolia account.

  2. Navigate to Dashboard > Search. For more information, see Index name.

  3. Copy the Index which is next to the Application.

Additional references