Reference

Get Conversion Rate

Retrieve conversion rate metrics for your search queries to understand how effectively your search is driving customer actions. This helps you identify which searches lead to purchases or desired outcomes so you can optimize your search experience.

Clicked Object IDs

Records when users click on items in your search results, helping you understand which products or content are most engaging and improving your search ranking algorithm over time.

Clicked Object IDs After Search

Track user interactions with search results by recording which items customers click on after performing a search. This helps you understand what products or content actually engage your audience.

Converted Object IDs

Track customer purchases and conversions for products that weren't discovered through Algolia search, helping you measure the full customer journey across your business. This ensures you capture conversion data from category pages, direct links, and other non-search paths to get accurate insights into what drives your sales.

Get Add to Cart Rate

Retrieve add-to-cart rate metrics for your e-commerce search to measure how effectively your product search is driving purchases and identify which search queries lead to conversions.

Get Average Click Position

Retrieve the average position of clicked search results to measure how visible and relevant your search results are to users. This helps you understand search quality and identify if top results are getting clicked or if users dig deeper.

Get Click Positions

Retrieve analytics data showing how many users clicked on search results at each position, helping you understand which result placements drive the most engagement.

Get Click Through Rate

Retrieve click-through rates for your searches to measure how effectively your search results drive user engagement and conversions.

Get No Click Rate

Retrieves the percentage of searches that didn't result in any user clicks, helping you understand which searches aren't delivering relevant results to your customers.

Get No Results Rate

Retrieves the percentage of searches that return no results, helping you identify gaps in your search index and improve customer search experience. Use this to understand which search queries are failing and where your product catalog or content may need expansion.

Get No Results Searches

Retrieve the most frequent searches that returned no results, helping you identify gaps in your content or product catalog. Use this data to discover what customers are looking for but can't find on your site.

Get Object Position

Retrieves the ranking position of a specific product or item within search results, helping you understand how your content is being ranked and discovered by users.

Get Purchase Rate

Retrieve purchase rate metrics to understand how effectively your search results convert to actual purchases, with daily breakdown data for performance analysis.

Get Revenue

Retrieve revenue metrics and conversion data from your Algolia search analytics to understand how your search functionality is driving sales and customer value.

Get Searches Count

Retrieves the total number of searches performed on your index within a specified time period, with daily breakdown details. This helps you understand search activity and user engagement patterns for your content or products.

Get Searches No Clicks

Identifies search queries that users performed but didn't click on any results, helping you find gaps in your content or search quality issues that need fixing.

Get Top Countries

Retrieve the countries with the highest search volume for your index to understand your geographic user distribution and where your audience is most active.

Get Top Filter Attributes

Identifies the most frequently used filters in your search analytics, helping you understand which product attributes matter most to your customers.

Get Top Filter For Attribute

Identify the most frequently used filter values for a specific product attribute to understand customer search behavior and preferences. This helps optimize your filtering options and product categorization based on actual user demand.

Get Top Filters No Results

Identifies the most commonly used filters that lead to zero search results in your Algolia search engine, helping you understand why customers can't find what they're looking for.

Get Top Hits

Retrieve the most frequently searched items from your Algolia search analytics to understand what customers are looking for and how well those results perform with click-through and conversion metrics.

Get Top Searches

Retrieve your most popular search queries ranked by frequency, optionally with click-through rates and revenue data to understand what customers are looking for.

Get Users Count

Retrieve the total number of unique users accessing your search index during a specific time period, with a daily breakdown of user activity. Use this to track how many people are actively using your search and identify engagement trends.

Create Authentication

Set up secure authentication credentials to connect your data sources or destinations within Algolia's system, enabling safe data ingestion and integration workflows.

Delete Authentication

Remove an authentication resource from your Algolia account when you no longer need it or want to revoke access credentials. This helps maintain security by cleaning up unused or compromised authentication tokens.

Get Authentication

Retrieve details about a specific authentication configuration you've set up in Algolia, allowing you to view and verify how your data sources are authenticated.

List Authentications

Retrieve all authentication credentials and configurations stored in your Algolia account to manage API keys and access permissions. Use this to audit what authentication methods are currently active or to find specific credentials for integration purposes.

Search Authentications

Find and retrieve specific authentication configurations in Algolia by their IDs, allowing you to quickly access and verify security settings across your search infrastructure.

Update Authentication

Update your Algolia search authentication settings to modify credentials or change how your application connects to Algolia's search service. This ensures your search functionality stays secure and properly configured as your setup evolves.

Batch Operations on Multiple Indices

Apply multiple changes (adding, updating, or deleting records) across different search indices simultaneously, reducing the number of API calls needed. This is ideal when you need to keep multiple product catalogs, content libraries, or data collections synchronized with a single request.

Get Dictionary Languages

Retrieve the list of languages supported for dictionary entries in your Algolia search configuration. This helps you understand which languages can have custom dictionaries for plurals, stopwords, and compound words.

Get Dictionary Settings

Retrieve the current dictionary settings to see which language-specific entries are disabled across your search setup. This helps you understand how your search is configured for different languages.

Search Dictionary Entries

Find specific words, phrases, and language variations across your Algolia dictionaries to understand how your search system handles different word forms and stop words.

Set Dictionary Settings

Update dictionary settings for your search index to control how Algolia processes language-specific features like stop words, plurals, and compound words. This helps you fine-tune search behavior to match your content and improve search result relevance.

Update Dictionary Entries

Batch add or remove dictionary entries like stopwords, plurals, and compound words to customize how your search engine indexes and matches content. This helps you fine-tune search results to match your business terminology and user expectations.

Browse Algolia Index

Retrieve and iterate through all records stored in your Algolia search index. This is useful when you need to access your complete dataset for analysis, migration, or bulk processing tasks.

Copy Index

Duplicates an existing search index including all records, settings, synonyms, and rules to create an identical copy under a new name. This is useful when you want to preserve your current search configuration while testing changes or creating variations.

Delete Index

Permanently remove a search index and all its associated records from your Algolia account. Use this when you no longer need a specific index and want to clean up your search infrastructure.

Get Index Settings

Retrieve the complete configuration and settings of your search index to verify how it's set up and understand its current behavior. This helps you confirm that your search index has the right setup for your business needs.

Index Exists

Verify whether a specific search index exists in your Algolia account before performing operations on it. This helps prevent errors and ensures you're working with the correct index.

List Indices

View all your search indices and their metadata including names and sizes, helping you organize and manage your search configuration.

Set Index Settings

Configure how your search index behaves by customizing searchable fields, ranking rules, and other index settings to optimize search results for your specific use case.

Create Ingestion Task

Set up automatic data synchronization between your data source and an Algolia search index to keep your search results fresh and accurate. This enables real-time or scheduled updates without manual intervention.

Create Destination

Set up a new destination in Algolia to receive and store ingested data from your sources. This enables you to configure where your indexed content will be delivered for search functionality.

Create Source

Set up a new data source in Algolia to begin ingesting data from external platforms or custom feeds, enabling you to keep your searchable content synchronized and up-to-date.

Delete Destination

Permanently removes a destination from your Algolia search setup, stopping data synchronization to that location.

Delete Source

Permanently remove a data source from your Algolia search index when you no longer need it to sync content. This helps keep your search infrastructure clean and reduces unnecessary data processing.

Get Destination

Retrieve detailed information about a specific Algolia destination by its ID, such as configuration settings and status. Use this when you need to verify destination details or troubleshoot data synchronization issues.

Get Source

Retrieve detailed information about a specific data source you've connected to Algolia, including its configuration and status.

List Destinations

Retrieve all your Algolia data destinations to see where your indexed data is being sent and manage your data pipeline destinations.

List Ingestion Tasks

Retrieve and review all your configured data ingestion tasks in Algolia to monitor pipeline status and manage automated data synchronization across your systems.

List Sources

Retrieve all your configured data sources in Algolia to see what content can be ingested into your search indexes. Use this to manage, monitor, and organize your data pipelines.

Search Destinations

Quickly retrieve multiple destination records by their IDs to access detailed information about specific locations or venues you work with. This helps you efficiently manage and reference destination data without searching through your entire database.

Search Sources

Retrieve specific data sources from Algolia by their IDs to access and manage your indexed content sources efficiently.

Update Destination

Modify an existing destination's configuration, name, type, or transformations in your Algolia search index.

Update Source

Modify an existing data source's configuration, including its name, authentication details, or input settings in Algolia to keep your search index up to date.

Validate Source

Verify that your data source configuration is correct and compatible with Algolia before actually creating it, preventing failed source setups and data sync issues.

Validate Source Before Update

Verify that changes to your search source configuration are valid and won't cause errors before applying them to your live index.

Init Insights API Client

Prepares your Algolia Insights client so you can start tracking user search behavior and interactions with your search results.

Get Logs

Retrieve detailed log entries for all API requests made to your Algolia search application, helping you understand what's happening behind the scenes with your search functionality.

Compute Realtime User Profile

Generates a real-time personalization profile for a specific user in Algolia, capturing their behavior and preferences to enable customized search results and product recommendations.

Delete User Profile

Removes a user's personalization data and profile from your Algolia search index, allowing you to reset their preferences and search history. Use this when a user requests data deletion or you need to clean up inactive accounts.

Delete User Token

Remove all analytics and events data associated with a specific user token from your Algolia Insights, helping you maintain clean data when users are deleted or their tracking should stop.

Get Personalization Config

Retrieve your Algolia personalization settings to understand how search results are customized for individual users, including re-ranking rules and profile types.

Get Users

Retrieve user profiles from your Algolia personalization system to access user preferences, behaviors, and interaction history. This helps you understand customer engagement patterns and personalization data for your search and recommendation features.

Set Personalization Strategy

Configure how user behavior like clicks and purchases influence search rankings to deliver more relevant results tailored to individual users. This helps you create a smarter search experience that adapts to what each customer actually wants.

Create Query Suggestions Config

Sets up query suggestions for an Algolia search index to help users discover and autocomplete popular search terms. This improves user experience by guiding visitors toward relevant content and products.

Delete Query Suggestions Config

Remove a Query Suggestions configuration from your search index to stop providing search recommendations or clean up unused configurations. Use this when you no longer need auto-completion suggestions for a particular search experience.

Get Query Suggestions Config

Retrieve the Query Suggestions configuration settings for a specific search index to inspect how your search suggestions are currently set up and optimized.

List Query Suggestions Configurations

Retrieve all Query Suggestions configurations set up in your Algolia application to view and audit your current search suggestion settings.

Update Query Suggestions Config

Modify the settings and behavior of query suggestions for your search index, such as which queries are suggested, how they're ranked, or when they appear to users.

Create or Update Recommend Rules

Create or update multiple recommendation rules in your Algolia search index to control which products or content are suggested to customers based on their behavior and preferences.

Delete Recommend Rule

Remove a specific rule from your search recommendation model to stop it from influencing how products or content are suggested to your customers.

Get Recommend Rule

Retrieve the configuration and settings of a specific recommendation rule you've created in Algolia to review how it's currently set up. This lets you verify rule details before making changes or troubleshooting why recommendations aren't working as expected.

Search Recommend Rules

Find and retrieve recommendation rules set up in your Algolia index to manage personalized product suggestions for your customers. This helps you discover which rules are currently active and how they're configured for your recommendation scenarios.

Add Record to Index

Adds a new searchable record to your Algolia index, automatically generating a unique ID for the entry. This enables you to populate your search database with product information, content, or customer data that can then be instantly searched by your users.

Delete Records by Filter

Remove multiple records from your search index based on specific filter criteria like category, status, or date range. This helps keep your searchable data clean and up-to-date without manually deleting items one-by-one.

Partial Update Objects

Efficiently update specific fields across multiple search records without replacing entire entries, saving time when making targeted changes to your indexed data.

Add or Replace Record

Updates or creates a searchable record in your Algolia index using a specific ID, ensuring you always have the latest information without duplicates. Perfect for maintaining current product catalogs, customer data, or content that needs frequent refreshing.

Clear Objects

Remove all records from a search index while keeping your index settings and configuration intact. Use this when you need a fresh start without reconfiguring your search setup.

Delete Multiple Records

Remove multiple items from your Algolia search index by their IDs in a single operation, helping you keep your searchable catalog clean and up-to-date.

Get multiple objects

Retrieve multiple records from your search index in a single request, making it efficient to fetch product details, user profiles, or other indexed data without multiple individual calls.

Get Record from Index

Retrieve a specific record's complete details from your search index using its unique identifier, useful when you need to access detailed information about a single item without running a full search.

Update Record Partially

Modify specific fields in your search index records without replacing the entire record, keeping your data up-to-date efficiently. Automatically creates a new record if it doesn't already exist.

Clear Rules

Removes all rules from a search index, allowing you to start fresh with a clean slate. Use this when reorganizing your search behavior or preparing to implement a new set of rules.

Delete Rule

Permanently removes a search rule from your index, allowing you to clean up outdated rules or correct mistaken configurations.

Export Rules

Export all rules configured for a search index to create backups or prepare for migration to another system. This ensures you don't lose custom search behaviors and ranking logic you've set up.

Get Rule

Retrieve the complete configuration of a specific search rule from your Algolia index to review how it's set up and what actions it performs.

Replace All Rules

Instantly replace all search rules in your index with a new set without any downtime, ensuring your search behavior updates are applied atomically across all queries.

Save Rule

Create or update a rule in your search index to customize how search results are delivered, including merchandising priorities, query adjustments, and conditional behaviors based on user searches.

Search Algolia Index

Search across your Algolia index to find specific records based on keywords or criteria, retrieving exactly the information you need without manually browsing through data.

Find Object

Retrieves the first object from your search index that matches your query or filter criteria, helping you verify search results and test your index configuration.

Search Facet Values

Find and retrieve specific values within a product attribute (like size, color, or brand) that match your search criteria, helping you populate filtered search options for your customers.

Search Multiple Indices

Execute searches across multiple Algolia indices simultaneously in a single request, allowing you to retrieve results from different datasets without making separate API calls.

Create API Key

Generate a new API key with custom permissions and restrictions to control access to your search indexes and manage different security levels for various applications or team members.

Delete API Key

Remove an API key from your Algolia application when you no longer need it or want to revoke access. This helps maintain security by eliminating unused or compromised keys.

Get API Key

Retrieve detailed information about a specific API key including its permissions, access controls, and configuration settings. Use this when you need to audit or verify what an API key can do within your search infrastructure.

List API Keys

Retrieve all API keys for your Algolia application along with their associated permissions and restrictions. This helps you audit security access and manage who can interact with your search infrastructure.

Restore API Key

Recover an API key that was accidentally deleted within 72 hours, allowing you to regain access to your Algolia search integration without regenerating credentials.

Update API Key

Modify permissions, restrictions, and settings for an existing API key to control what applications or services can access and do within your search index.

Clear Synonyms

Remove all synonym definitions from your search index in a single operation, allowing you to reset or refresh your search terminology without manually deleting each entry.

Delete Synonym

Removes a synonym from your search index so outdated or incorrect term associations no longer affect search results. Use this when you need to clean up search behavior by deleting old synonym mappings.

Get Synonym

Retrieve detailed information about a specific search synonym in your Algolia index by its unique identifier. Use this to view or verify synonym configurations you've previously created.

Save Synonym

Add or update search synonyms in your Algolia index to make your search results more relevant by linking related terms together. This helps customers find products even when they use different words or phrases.

Save Synonyms

Add or update multiple search synonyms in your Algolia index at once, enabling customers to find products using alternative terms or similar keywords.

Search Synonyms

Find synonym configurations in your search index to understand and manage how search terms are mapped together. This helps you optimize search results by seeing which term relationships are already set up.

Disable Task V1

Stop a data synchronization task in Algolia without deleting it, allowing you to pause ingestion temporarily and resume later without reconfiguring.

Enable Task V1

Activates a previously disabled task in your Algolia search index, allowing it to resume processing and indexing data. Use this when you need to turn data synchronization back on after temporarily pausing it.

Get App Task Status

Check whether a background task in your Algolia search application has finished processing, helping you know when updates or operations are ready to use.

Get Recommend Task Status

Check whether an asynchronous Recommend operation has finished processing so you know when your search personalization changes are live.

Get Task Status

Check the status of asynchronous operations in your Algolia search index, such as record updates or deletions, to confirm when changes have been fully processed and are live in your search.

Get Task V1

Retrieve detailed information about a specific task from your Algolia data ingestion system, including its status, progress, and configuration details.

List Task Runs

Retrieve a list of your scheduled task executions to monitor progress, check completion status, and track when jobs ran. Helps you stay on top of automation performance and identify any failed or delayed tasks.

Push Records to Task

Send data records to an Algolia ingestion task to automatically process and index your content for searchable applications. This is useful when you need to feed fresh data into your search system from various sources.

Replace Task

Completely update a task in Algolia Ingestion with new configuration by replacing all existing settings at once. Use this when you need to modify task parameters without keeping any of the previous configuration.

Run Task V1

Manually trigger the execution of a data ingestion task in Algolia to immediately process and index your data updates without waiting for scheduled runs.

Search Tasks V1

Retrieve details about multiple specific tasks from your Algolia task index to monitor ingestion progress and check job statuses. This helps you track the state of data synchronization processes without manually checking each task individually.

Update Task

Modify an existing task's configuration in Algolia without recreating it, allowing you to adjust scheduling, failure thresholds, destinations, or alerts on the fly. This saves time when you need to refine how your data is being processed and indexed.

Add AB Test

Create an A/B test to compare how different search configurations and ranking strategies perform with your users, helping you identify which setup delivers better search results and engagement.

Delete AB Test

Permanently remove an A/B test from your search configuration, allowing you to clean up completed or underperforming experiments and free up testing resources.

Get A/B Test

Retrieve detailed information about a specific A/B test including its status, performance metrics, and configuration settings to monitor how different search strategies are performing.

List AB Tests

Retrieve all A/B tests you've set up in your Algolia search, letting you quickly check which tests are running, their current status, and gather test details for analysis or modifications.

Stop AB Test

Immediately halt an active A/B test on your Algolia search index when you've gathered enough data or identified a clear winner. This permanently stops the test and removes it from active rotation.

Create Transformation

Set up automatic data transformations to enrich, modify, or reformat your records as they're ingested into Algolia, ensuring your search data is clean and properly structured. This is useful when you need to standardize formats, extract data, or enhance records before they become searchable.

Delete Transformation

Permanently remove a transformation from your Algolia search index when you no longer need it processing your data. Use this to clean up outdated transformation rules and keep your search configuration organized.

Get Transformation

Retrieve detailed information about a specific transformation you've created in Algolia, including its configuration and code. Use this to review, verify, or debug how your data is being processed before it gets indexed.

List Transformations

Retrieve all transformations configured in your Algolia Ingestion pipeline to view, audit, or manage your data processing rules.

Search Transformations

Retrieve specific transformation configurations from your Algolia setup by searching for them using their IDs, allowing you to quickly access and review multiple transformation rules at once.

Try Transformation

Test transformation logic against sample data before deploying to your Algolia search index, ensuring your data transformations work correctly without affecting live content.

Try Transformation Before Update

Test a data transformation against sample data to verify it works correctly before applying it to your live Algolia search index. This helps catch errors and ensures your data is processed exactly as intended.

Update Transformation

Modify transformation rules and settings that process your data during ingestion into Algolia, allowing you to update how data is cleaned, formatted, or enriched before search indexing.

Get Usage for Index

Retrieve detailed usage statistics for your Algolia search index, including record counts, query volumes, and processing times to monitor performance and identify optimization opportunities.

Get Usage Statistics

Retrieve detailed usage statistics for your Algolia search service to monitor search operations, indexing activity, and resource consumption over a specified period.