> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Algolia

> How to set up the Algolia connector, plus the actions that are available.

![Algolia](https://stackone-logos.com/api/algolia/filled/svg)

v1.1.0[See changelog](https://docs.stackone.com/connectors/algolia/changelog.md)

[42 actions](#actions) · 1 auth method

Search

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/algolia/guides/connector-profile/api-key.md)
>
> Connect your Algolia account using your Application ID and API Key from the Algolia dashboard.

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/algolia/guides/link-account/api-key.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

42 actions

ActionDescription

Retrieve Top Searches`algolia_retrieve_top_searches`

Retrieves the most popular search queries.

Retrieve Number Of Searches`algolia_retrieve_number_of_searches`

Retrieves the total number of searches over time.

Retrieve Searches No Results`algolia_retrieve_searches_no_results`

Retrieves the most frequent searches without results.

Retrieve Click Through Rate`algolia_retrieve_click_through_rate`

Retrieves click-through rate analytics.

Retrieve Average Click Position`algolia_retrieve_average_click_position`

Retrieves the average position of clicked results.

Retrieve Top Search Results`algolia_retrieve_top_search_results`

Retrieves the most frequently returned search results.

Retrieve Number Of Users`algolia_retrieve_number_of_users`

Retrieves the number of unique users.

Retrieve No Results Rate`algolia_retrieve_no_results_rate`

Retrieves the rate of searches returning no results.

Retrieve Searches No Clicks`algolia_retrieve_searches_no_clicks`

Retrieves top searches that received no clicks.

Retrieve No Click Rate`algolia_retrieve_no_click_rate`

Retrieves the rate of searches without any clicks.

Retrieve Click Positions`algolia_retrieve_click_positions`

Retrieves click position distribution analytics.

List Indices`algolia_list_indices`

Lists all indices in your Algolia application.

Delete Index`algolia_delete_index`

Deletes an index and all its data.

Copy Or Move Index`algolia_copy_or_move_index`

Copies or moves (renames) an index within the same Algolia application.

Retrieve Task Status`algolia_retrieve_task_status`

Gets the status of an asynchronous task.

Send Events`algolia_send_events`

Sends click, conversion, or view events to Algolia Insights API for analytics and personalization.

List API Keys`algolia_list_api_keys`

Lists all API keys associated with your Algolia application, including their permissions and restrictions.

Get API Key Info`algolia_get_api_key_info`

Retrieves the permissions and details of the current API key.

Retrieve Record`algolia_retrieve_record`

Retrieves a single record by its objectID.

Add A New Record`algolia_add_new_record`

Adds a record to an index or replaces it with an auto-generated objectID.

Add Or Replace Record`algolia_add_or_replace_record`

Adds or replaces a record with a specific objectID.

Add Or Update Attributes`algolia_add_or_update_attributes`

Partially updates a record by adding or modifying specific attributes.

Delete Record`algolia_delete_record`

Removes a record from an index.

Batch Indexing Operations On One Index`algolia_batch_indexing_operations`

Adds, updates, or deletes records in one index with a single API request.

Browse For Records`algolia_browse_for_records`

Retrieves records from an index, up to 1,000 per request.

Delete Records Matching A Filter`algolia_delete_records_matching_filter`

Deletes all records matching filter criteria. This operation doesn't accept empty filters.

Retrieve A Rule`algolia_retrieve_a_rule`

Retrieves a single rule by its ID.

Create Or Replace A Rule`algolia_create_or_replace_rule`

Creates or replaces a query rule.

Delete A Rule`algolia_delete_a_rule`

Removes a rule from the index.

Create Or Update Rules`algolia_create_or_update_rules`

Creates or updates multiple rules at once.

Delete All Rules`algolia_delete_all_rules`

Removes all rules from an index.

Search For Rules`algolia_search_for_rules`

Searches for rules in your index.

Search Single Index`algolia_search_single_index`

Searches for records in a single index and returns matching hits.

Search Multiple Indices`algolia_search_multiple_indices`

Searches across multiple indices in a single request.

Get Index Settings`algolia_retrieve_index_settings`

Retrieves all settings for an index.

Update Index Settings`algolia_update_index_settings`

Updates settings for an index.

Search For Synonyms`algolia_search_for_synonyms`

Retrieves all synonyms for an index.

Retrieve A Synonym`algolia_retrieve_a_synonym`

Retrieves a single synonym by its ID.

Create Or Replace A Synonym`algolia_create_or_replace_a_synonym`

Creates or updates a single synonym.

Delete A Synonym`algolia_delete_a_synonym`

Removes a synonym from the index.

Delete All Synonyms`algolia_delete_all_synonyms`

Removes all synonyms from an index.

Create Or Replace Synonyms`algolia_create_or_replace_synonyms`

Creates or updates multiple synonyms at once.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.