Skip to main content
Algolia logo
  • Category: developer tools
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 133
  • Triggers: 0
  • Slug: ALGOLIA
  • Version: 20261101_00

Tools

Slug: ALGOLIA_ADD_AB_TESTTool to create an A/B test comparing search performance between two index variants. Use when you need to test different search configurations, ranking strategies, or index settings and measure their impact on user behavior.

Input Parameters

string
required
Descriptive name for the A/B test to identify it in the dashboard.
string
required
End date and time of the A/B test in RFC 3339 format (e.g., ‘2026-02-18T23:59:59Z’). Test will automatically stop at this time.
string
Algolia analytics API region. Valid values: ‘us’, ‘de’. Defaults to ‘de’ (EU region).
array
required
Exactly two variants to test. Traffic percentages must sum to 100.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_ADD_OR_REPLACE_RECORDTool to add or replace a specific record in an index by objectID. If a record with the given objectID exists, it is replaced; otherwise, a new record is created. Use when you need to upsert an object with a known ID.

Input Parameters

object
required
Record data to add or replace in the index. Can include any attributes. The objectID field in the record body is optional but should match the objectID parameter if provided.
string
required
Unique record identifier. If a record with this objectID exists, it will be replaced; otherwise, a new record is created.
string
required
Name of the index on which to perform the operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_ADD_RECORDTool to add a record to an index with auto-generated objectID. Records with matching IDs are replaced. Use when you need to insert a new object into an index.

Input Parameters

object
required
Record data to add to the index. Can include any attributes. If objectID is provided, it will be used; otherwise, one will be auto-generated. Records with matching IDs are replaced.
string
required
Name of the index on which to perform the operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_BROWSE_INDEXBrowse a batch of records in an Algolia index, optionally filtering them by query or browse parameters. Use the returned cursor to request subsequent batches when exporting or iterating through an index.

Input Parameters

string
Search query to filter records; empty or omitted returns all records.
string
Cursor to specify the starting point for the next batch of results.
string
required
Name of the Algolia index to browse.
object
Additional browse parameters as key-value pairs (e.g., filters, hitsPerPage).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_CLEAR_OBJECTSTool to clear records of an index without affecting settings. Use when you need to completely wipe all objects (e.g., after a bulk reindex) while preserving index configuration.

Input Parameters

string
required
Name of the index from which to clear all records.
object
Optional mapping of request options (query parameters) as string values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_CLEAR_RULESClear all rules from an Algolia index, optionally forwarding the operation to replica indices. A 404 response is returned as a no-op with task ID 0.

Input Parameters

string
required
Name of the Algolia index from which to clear all rules.
boolean
If true, also clears rules on all replica indices.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_CLEAR_SYNONYMSClear all synonyms from an Algolia index, optionally forwarding the operation to replica indices.

Input Parameters

string
required
Name of the index from which to clear all synonyms.
boolean
Whether changes are applied to replica indices.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_CLICKED_OBJECT_IDSTool to send a click event to Algolia to capture clicked items. Use immediately after a user click outside of search contexts to report click events.

Input Parameters

string
required
Name of the specific event (1-64 ASCII printable characters).
string
required
Name of the Algolia index where the event occurred.
array
required
List of clicked object IDs (1-20 items).
string
required
Anonymous user identifier. Allowed chars: alphanumeric, ’_’, ’=’, ’+’, ’/’, ’-’; length 1-129.
string
Pseudonymous identifier for authenticated users; same pattern as userToken.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_CLICKED_OBJECT_IDS_AFTER_SEARCHTool to send a click event after a search response. Use when you want to report which items a user clicked in search results.

Input Parameters

string
required
Name of the index where the click occurred.
string
required
queryID returned by Algolia Search API for the request.
string
required
Name for this click event, e.g. ‘Product Clicked’.
array
required
List of objectIDs that were clicked.
array
required
Positions (1-based) of clicked objects in the search results. Must be strictly positive integers.
integer
Event timestamp in milliseconds since epoch. If omitted, server timestamp is used.
string
required
Unique token identifying the user, consistent across events.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_COMPUTE_REALTIME_USERTool to compute a user’s real-time personalization profile in Algolia. Use when you need to trigger calculation of personalization data for a specific user. Note: This endpoint is deprecated.

Input Parameters

string
required
Unique pseudonymous or anonymous user identifier for which to compute the personalization profile.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_CONVERTED_OBJECT_IDSTool to send a conversion event for items outside of search context. Use when tracking conversions on category pages or external flows unrelated to Algolia search.

Input Parameters

string
required
Name of the Algolia index where conversion happened.
string
required
Name of the specific conversion event. 1–64 ASCII characters except control characters.
array
required
List of object IDs for items converted. Up to 20 IDs.
integer
Event timestamp in milliseconds since epoch. If omitted, server timestamp is used.
string
required
Unique token identifying the user, e.g., ‘user-123’.
string
Optional pseudonymous token for authenticated users. Never include PII.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_COPY_INDEXInitiate an index copy and return an asynchronous task ID. Copy all parts including records, or specify settings, synonyms and rules as the scope; specifying a scope excludes records.

Input Parameters

array
Parts of the index to copy. Allowed values: ‘settings’, ‘synonyms’, ‘rules’. If omitted, all parts (including records) are copied. If specified, records are not copied.
string
required
Name of the source index to copy.
string
required
Name of the destination index to create.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_CREATE_API_KEYTool to create a new API key with specific permissions and restrictions. Use when you need to generate API keys with custom ACL permissions, index restrictions, rate limits, or expiration times.

Input Parameters

array
required
Permissions that determine the type of API requests this key can make. The required ACL is listed in each endpoint’s reference. For more information, see access control list (ACL).
array
Index names or patterns that this API key can access. By default, an API key can access all indices in the same application. You can use leading and trailing wildcard characters (): ‘dev_’ matches all indices starting with ‘dev_’, ‘_dev’ matches all indices ending with ‘_dev’, ‘products*’ matches all indices containing ‘products’.
array
Allowed HTTP referrers for this API key. By default, all referrers are allowed. You can use leading and trailing wildcard characters (): ‘https://algolia.com/’ allows all referrers starting with ‘https://algolia.com/’, ‘*.algolia.com’ allows all referrers ending with ‘.algolia.com’, ‘algolia.com’ allows all referrers in the domain ‘algolia.com’. Like all HTTP headers, referrers can be spoofed. Don’t rely on them to secure your data.
integer
Duration (in seconds) after which the API key expires. By default, API keys don’t expire.
string
Description of an API key to help you identify this API key.
integer
Maximum number of results this API key can retrieve in one query. By default, there’s no limit.
string
Query parameters to add when making API requests with this API key. To restrict this API key to specific IP addresses, add the restrictSources parameter. You can only add a single source, but you can provide a range of IP addresses. Creating an API key fails if the request is made from an IP address outside the restricted range.
integer
Maximum number of API requests allowed per IP address or user token per hour. If this limit is reached, the API returns an error with status code 429. By default, there’s no limit.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_CREATE_AUTHENTICATIONCreate an authentication resource in the US region of Algolia’s ingestion API for connecting to sources or destinations.

Input Parameters

string
required
Descriptive name for the resource.
string ("googleServiceAccount" | "basic" | "apiKey" | "oauth" | "algolia" | "algoliaInsights" | "secrets")
required
Type of authentication. This determines the type of credentials required in the input object.
object
required
Authentication credentials object. The structure varies based on the authentication type. For ‘basic’ type: {username: str, password: str}. For ‘googleServiceAccount’ type: {clientEmail: str, privateKey: str}. For ‘apiKey’ type: {key: str}. For ‘oauth’ type: {url: str, client_id: str (optional), client_secret: str (optional), code: str (optional), scope: str (optional)}. For ‘algolia’ type: {appID: str, apiKey: str}. For ‘algoliaInsights’ type: {appID: str, apiKey: str}. For ‘secrets’ type: custom key-value pairs.
string
Platform associated with this authentication.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_CREATE_DESTINATIONCreate a destination for data ingestion using the US Algolia Ingestion API endpoint.

Input Parameters

string
required
Descriptive name for the resource.
string ("search" | "insights")
required
Destination type. ‘search’ means data is stored in an Algolia index. ‘insights’ means data is recorded as user events in the Insights API.
object
required
Input configuration for the destination.
string
required
Universally unique identifier (UUID) of an authentication resource.
array
List of transformation IDs to associate with the destination.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_CREATE_INGESTION_TASKCreate an ingestion task connecting a source to a destination for data synchronization with an Algolia index. The request uses the US ingestion endpoint.

Input Parameters

string
Cron expression for the task’s schedule. Use standard cron syntax to define when the task should run automatically.
object
Configuration of the task input, depending on its type. Structure varies: for streaming input use ‘mapping’ object, for docker streams use ‘streams’ array, for Shopify use ‘metafields’ array and ‘market’ object.
string ("replace" | "save" | "partial" | "partialNoCreate" | "append")
required
Action to perform on the Algolia index. Defines how records are updated: ‘replace’ replaces all records, ‘save’ adds or updates records, ‘partial’ updates specific attributes, ‘partialNoCreate’ updates without creating, ‘append’ adds new records.
string
Date and time when the last cursor was created, in RFC 3339 format. Used for incremental data synchronization.
boolean
Whether the task is enabled. If false, the task will not run automatically even if scheduled.
object
Set of rules for a task.
string
required
Universally unique identifier (UUID) of a source resource.
string
required
Universally unique identifier (UUID) of a destination resource.
object
Notification settings for a task.
integer
Maximum accepted percentage of failures for a task run to finish successfully. Task will fail if failure rate exceeds this threshold.
string ("replace" | "save" | "partial" | "partialNoCreate" | "append")
Action to perform on the Algolia index.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_CREATE_OR_UPDATE_RECOMMEND_RULESTool to create or update a batch of Recommend Rules in an index. Use when you need to add or modify multiple rules at once for a recommendation model. Each rule is created or updated depending on whether a rule with the same objectID already exists.

Input Parameters

string ("related-products" | "bought-together" | "trending-facets" | "trending-items")
required
Recommend model (related-products, bought-together, trending-facets, or trending-items).
array
required
List of Recommend rules to create or update. Each rule is created or updated based on whether a rule with the same objectID already exists.
string
required
Name of the index on which to perform the operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_CREATE_QS_CONFIGTool to create a new Query Suggestions configuration for an Algolia index. Use when you need to set up query suggestions to help users discover popular searches. Up to 100 configurations per application are supported.

Input Parameters

string ("us" | "eu")
Analytics region for your Algolia application (us or eu). Must match your application’s analytics region configured in the Algolia dashboard under Infrastructure > Analytics
array
List of words or regular expressions to exclude from query suggestions
string
required
Name of the Query Suggestions index to create. This will be the destination index for generated suggestions
string
Languages for deduplicating singular/plural suggestions. Set to true to enable for all languages, or provide an array of specific language codes (e.g., [‘en’, ‘fr’])
array
required
Array of source index configurations to use for generating query suggestions. At least one source index is required
boolean
Whether to enable personalized query suggestions based on user behavior. Default is false
boolean
Whether to include suggestions with special characters. Default is false

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_CREATE_SOURCETool to create a new data source in Algolia Ingestion API. Use when you need to set up a new source for data ingestion from external platforms or custom data feeds.

Input Parameters

string
required
Descriptive name for the source.
string ("bigcommerce" | "bigquery" | "commercetools" | "csv" | "docker" | "ga4BigqueryExport" | "json" | "shopify" | "push")
required
Type of data source to create. Options: bigcommerce, bigquery, commercetools, csv, docker, ga4BigqueryExport, json, shopify, push. The ‘push’ type is for sources where data is pushed directly via API.
object
Input configuration for the source. Structure varies by source type. Key required fields: commercetools requires url + projectKey; bigcommerce requires storeHash; json/csv require url; bigquery/ga4BigqueryExport require projectID + datasetID; docker requires image + configuration; push needs no input.
string
Region for the Algolia Ingestion API endpoint. The API will be called at https://data.{region}.algolia.com. Valid values: ‘us’, ‘eu’.
string
Universally unique identifier (UUID) of an authentication resource. Required for most source types except ‘push’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_CREATE_TRANSFORMATIONTool to create a new transformation in Algolia Ingestion API. Use when you need to set up data transformations for enriching or modifying records during ingestion.

Input Parameters

string
required
The uniquely identified name of your transformation.
string ("code" | "noCode")
required
The type of transformation: ‘code’ for JavaScript code transformations, or ‘noCode’ for visual no-code transformations.
object
required
The input for the transformation. For ‘code’ type, provide a ‘code’ field with JavaScript. For ‘noCode’ type, provide a ‘steps’ field with the transformation steps.
string
A descriptive name for your transformation explaining what it does.
array
The authentications (UUIDs) associated with the transformation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_DELETE_AB_TESTTool to delete an A/B test by its unique identifier. Use when you need to permanently remove an A/B test configuration.

Input Parameters

integer
required
Unique A/B test identifier.
string
Algolia analytics API region. Valid values: ‘us’, ‘de’. Defaults to ‘de’ (EU region).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_DELETE_API_KEYDelete an Algolia API key to revoke access. Deleting a main API key also deletes all secured API keys derived from it.

Input Parameters

string
required
API key to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_DELETE_AUTHENTICATIONDelete an Algolia ingestion authentication resource by ID in the US region.

Input Parameters

string
required
Unique identifier of an authentication resource.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_DELETE_CONFIGTool to delete a Query Suggestions configuration for the specified index. Use when you need to remove a Query Suggestions configuration permanently.

Input Parameters

string
required
Query Suggestions index name to delete the configuration for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_DELETE_DESTINATIONDelete a destination by ID using the US Algolia Ingestion API endpoint.

Input Parameters

string
required
Unique identifier of the destination to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_DELETE_INDEXTool to delete the specified index and all its records. Use when you need to permanently remove an index after confirming it’s no longer needed.

Input Parameters

string
required
The name of the index to be deleted

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_DELETE_OBJECTSTool to delete multiple records from an Algolia index. Use when you need to remove multiple objects by their IDs.

Input Parameters

string
required
Name of the index from which to delete records.
array
required
List of objectIDs to delete.
object
Optional mapping of request options (query parameters) as string values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_DELETE_RECOMMEND_RULETool to delete a Recommend rule from a recommendation scenario. Use when you need to remove a specific rule from an index’s recommend model.

Input Parameters

string ("related-products" | "bought-together" | "trending-facets" | "trending-items")
required
Recommend model for the recommendation scenario.
string
required
Unique record identifier of the rule to delete.
string
required
Name of the index on which to perform the operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_DELETE_RECORDS_BY_FILTERTool to delete records matching a filter from an Algolia index. Use when you need to remove multiple records based on filter criteria (e.g., category, tags, numeric ranges). This is a resource-intensive operation.

Input Parameters

string
Filter expression to only include items that match the filter criteria. Supports numeric filters (<, <=, =, !=, >, >=), ranges (facet:lower TO upper), facet filters (facet:value), tag filters (_tags:value), and boolean filters (facet: true | false). Combine filters with AND, OR, and NOT operators. Example: ‘(category:Book OR category:Ebook) AND _tags:published’
string
required
Name of the index on which to perform the operation.
string
Filter by values of the special ‘_tags’ attribute (deprecated, prefer using ‘filters’ parameter). Same combination rules apply as for facet_filters.
string
Maximum radius for a search around a central location. Works with around_lat_lng parameter. Can be an integer (meters) or ‘all’.
string
Filter by facet values (deprecated, prefer using ‘filters’ parameter). Format: [filter1, filter2] is AND, [[filter1, filter2], filter3] is (filter1 OR filter2) AND filter3.
string
Coordinates for the center of a circle, expressed as a comma-separated string of latitude and longitude. Only records within a circle around this location are included. Example: ‘40.71,-74.01’
array
Coordinates of a polygon in which to search. Each polygon is defined by 3 to 10,000 points (latitude, longitude pairs).
string
Filter by numeric facets (deprecated, prefer using ‘filters’ parameter). Supports comparison operators: <, <=, =, !=, >, >= and ranges (facet:lower TO upper).
object
Optional mapping of request options (query parameters) as string values.
string
Coordinates of a rectangle in which to search. Format: ‘lat1,lng1,lat2,lng2’ or nested arrays for multiple boxes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_DELETE_RULETool to delete the specified rule from an index. Use when you need to permanently remove a rule after confirming its objectID.

Input Parameters

string
required
Unique identifier of the rule to delete.
string
required
Name of the Algolia index from which to delete the rule.
boolean
Whether to forward this deletion to replica indices. If false (default), only the specified index is affected.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_DELETE_SOURCEDelete an Algolia Ingestion API source by ID. The tool uses a data API endpoint supplied in connection metadata, or otherwise the US ingestion endpoint.

Input Parameters

string
required
Unique identifier of the source to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_DELETE_SYNONYMTool to delete a synonym from a specified index. Use when you need to remove an existing synonym by its objectID.

Input Parameters

string
required
ObjectID of the synonym to delete.
string
required
Name of the Algolia index from which to delete the synonym.
boolean
Whether to forward this deletion to all replica indices. If false (default), only the specified index is affected.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_DELETE_TRANSFORMATIONTool to delete a transformation in Algolia Ingestion API. Use when you need to permanently remove a transformation by its ID.

Input Parameters

string
required
Unique identifier of the transformation to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_DELETE_USER_PROFILETool to delete a user profile from personalization. Use when you need to remove a user’s personalization data and reset their profile.

Input Parameters

string
required
Unique identifier representing a user for which to fetch the personalization profile.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_DELETE_USER_TOKENDelete events related to a user token from Algolia Insights event metrics and analytics using the US Insights endpoint.

Input Parameters

string
required
User token for which to delete all associated events.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_DISABLE_TASK_V1Tool to disable a task V1 in Algolia Ingestion API. Use when you need to disable a specific task. Note: This API is deprecated but still functional.

Input Parameters

string
Algolia ingestion API region. Valid values: ‘us’, ‘eu’.
string
required
Unique identifier of a task.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_ENABLE_TASK_V1Tool to enable a task V1 in Algolia Ingestion API. Use when you need to activate a previously disabled task. Note: This API is deprecated but still functional.

Input Parameters

string
Algolia ingestion API region. Valid values: ‘us’, ‘eu’, ‘de’.
string
required
Unique identifier of a task.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_EXECUTE_BATCH_ON_MULTIPLE_INDICESTool to perform batch operations (add, update, delete) across multiple Algolia indices in a single request. Use when you need to modify records in different indices efficiently. Each operation specifies its target index and action type.

Input Parameters

array
required
Array of batch operations. Each operation specifies action, indexName, and body. All operations are executed in a single API call for efficiency. Must contain at least one operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_EXPORT_RULESExport a page of rules from an Algolia index for backup or migration. Use the returned cursor to retrieve subsequent pages.

Input Parameters

string
Page number to fetch (as a string); omit or set to ‘0’ to start from the beginning. Use the cursor value from a previous response to fetch the next page.
string
required
Name of the Algolia index to export rules from

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_FIND_OBJECTTool to find the first object matching a query or filter in an index. Use when debugging relevance or filter logic after confirming index exists.

Input Parameters

string
Query string to search for. If omitted, only filters are applied. Values must match the form stored in the index; URLs or other transformed values (e.g., cleaned paths, derived IDs) may be stored in a normalized form that differs from the raw input.
object
Additional Algolia search parameters as key-value pairs. Supports ‘filters’ (string with syntax like ‘category:Book AND price<100’), ‘facetFilters’, ‘numericFilters’, ‘hitsPerPage’, etc.
boolean
If True, searches across all pages until an object is found. If False, only searches the first page. Defaults to False.
string
required
Name of the Algolia index to search (e.g., ‘products’).
array
List of attributes to retrieve in the result. If omitted, all attributes are returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_GET_AB_TESTRetrieve an A/B test by ID from the DE analytics region, including its status, performance metrics, and configuration details.

Input Parameters

integer
required
Unique A/B test identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_GET_ADD_TO_CART_RATETool to retrieve add-to-cart rate metrics for e-commerce search analytics. Use when you need to analyze conversion effectiveness and user purchasing behavior for an index, including daily breakdowns.

Input Parameters

string
Tags by which to segment the analytics. You can combine multiple tags with OR and AND. Tags must be URL-encoded. For more information, see Algolia’s segment documentation.
string
required
Index name to retrieve add-to-cart rate for.
string
End date of the period to analyze, in YYYY-MM-DD format.
string
Start date of the period to analyze, in YYYY-MM-DD format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_GET_API_KEYTool to retrieve the permissions and details of a specific API key. Use when you need to inspect an API key’s ACL, restrictions, or other settings.

Input Parameters

string
required
The API key to retrieve. This is the key value (not the key ID).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_GET_APP_TASKTool to check the status of an application task. Use when you need to verify if a task has completed.

Input Parameters

integer
required
Unique task identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_GET_AUTHENTICATIONTool to retrieve an authentication resource by its ID. Use when you need to fetch details about a specific authentication configuration in Algolia’s ingestion API.

Input Parameters

string
Algolia ingestion API region. Valid values: ‘us’, ‘eu’.
string
required
Unique identifier (UUID) of an authentication resource.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_GET_AVERAGE_CLICK_POSITIONTool to retrieve average click position metrics from Algolia Analytics. Use when analyzing user engagement and click behavior for search results.

Input Parameters

string
Tags by which to segment the analytics. You can combine multiple tags with OR and AND. Tags must be URL-encoded. For more information, see Algolia documentation on segmenting analytics data.
string
required
Name of the Algolia index to retrieve click position metrics for.
string
End date of the period to analyze, in YYYY-MM-DD format.
string
Start date of the period to analyze, in YYYY-MM-DD format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_GET_CLICK_POSITIONSTool to retrieve the distribution of clicks by position from Algolia Analytics. Use when analyzing which search result positions receive the most user engagement.

Input Parameters

string
Tags by which to segment the analytics. You can combine multiple tags with OR and AND. Tags must be URL-encoded. For more information, see Algolia documentation on segmenting analytics data.
string
required
Name of the Algolia index to retrieve click position metrics for.
string
End date of the period to analyze, in YYYY-MM-DD format.
string
Start date of the period to analyze, in YYYY-MM-DD format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_GET_CLICK_THROUGH_RATETool to retrieve click-through rate (CTR) for searches with at least one click event. Use when you need to analyze search effectiveness and user engagement metrics for an index, including daily breakdowns.

Input Parameters

string
Tags by which to segment the analytics. You can combine multiple tags with OR and AND. Tags must be URL-encoded. For more information, see Algolia’s segment documentation.
string
required
Index name to retrieve click-through rate for.
string
End date of the period to analyze, in YYYY-MM-DD format.
string
Start date of the period to analyze, in YYYY-MM-DD format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_GET_CONFIGTool to retrieve a Query Suggestions configuration by index name. Use when you need to inspect or verify Query Suggestions settings for a specific index.

Input Parameters

string ("us" | "eu")
Analytics region for your Algolia application (us or eu). Check your region in the Algolia dashboard at account/infrastructure/analytics
string
required
Query Suggestions index name to retrieve the configuration for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_GET_CONFIG2Retrieve the advanced personalization configuration from the EU endpoint, including personalization settings, re-ranking impact and profile type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_GET_CONVERSION_RATERetrieve conversion rate analytics for an index from the US analytics endpoint, including daily breakdowns.

Input Parameters

string
Tags by which to segment the analytics. You can combine multiple tags with OR and AND. Tags must be URL-encoded. For more information, see Algolia’s segment documentation.
string
required
Index name to retrieve conversion rate for.
string
End date of the period to analyze, in YYYY-MM-DD format.
string
Start date of the period to analyze, in YYYY-MM-DD format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_GET_DESTINATIONRetrieve an Algolia ingestion destination by ID using the US endpoint.

Input Parameters

string
required
Unique identifier of the destination to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_GET_DICTIONARY_LANGUAGESTool to list available languages for dictionary entries. Use when you need to check which languages support custom dictionary entries (plurals, stopwords, compounds).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_GET_DICTIONARY_SETTINGSTool to retrieve dictionary settings for all dictionaries. Use when you need to check which standard dictionary entries are disabled across different languages.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_GET_LOGSTool to retrieve log entries for API requests made to your Algolia application. Use when you need to debug issues, monitor API usage, or analyze search patterns.

Input Parameters

string ("all" | "query" | "build" | "error")
Type of log entries to retrieve.
integer
Maximum number of log entries to retrieve. Algolia limits the maximum length per request.
integer
First log entry to retrieve. The most recent entries are listed first. Use this for pagination to skip earlier entries.
string
Index for which to retrieve log entries. By default, log entries are retrieved for all indices. Specify an index name to filter logs for a specific index.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_GET_NO_CLICK_RATERetrieve aggregate and daily no-click rates for tracked searches on an index, with optional date and tag filters. Use to analyze search engagement.

Input Parameters

string
Tags by which to segment the analytics. You can combine multiple tags with OR and AND. Tags must be URL-encoded. For more information, see Algolia’s segment documentation.
string
required
Index name to retrieve no-click rate for.
string
End date of the period to analyze, in YYYY-MM-DD format.
string
Start date of the period to analyze, in YYYY-MM-DD format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_GET_NO_RESULTS_RATERetrieve aggregate and daily no-results rates for an index using the US analytics endpoint. Use to analyze search effectiveness over a selected period.

Input Parameters

string
Tags by which to segment the analytics. You can combine multiple tags with OR and AND. Tags must be URL-encoded. For more information, see Algolia’s segment documentation.
string
required
Index name to retrieve no results rate for.
string
End date of the period to analyze, in YYYY-MM-DD format.
string
Start date of the period to analyze, in YYYY-MM-DD format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_GET_NO_RESULTS_SEARCHESRetrieve frequent searches that produced zero results for an index using the US analytics endpoint. Use to analyze search gaps or identify content opportunities.

Input Parameters

string
Tags by which to segment the analytics. You can combine multiple tags with OR and AND. Tags must be URL-encoded. For more information, see Algolia’s segment documentation.
string
required
Index name to retrieve no-results searches for.
integer
Number of items to return.
integer
Position of the first item to return.
string
End date of the period to analyze, in YYYY-MM-DD format.
string
Start date of the period to analyze, in YYYY-MM-DD format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_GET_OBJECT_POSITIONFind an object’s zero-based position by objectID in the hits of a supplied search response. Returns null if it is not present in those hits.

Input Parameters

object
required
Full JSON response from a previous Algolia search, containing the ‘hits’ list.
string
required
The objectID of the record to locate in the results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_GET_OBJECTSTool to retrieve multiple records from an index. Use when you need to batch-fetch several objectIDs in one call.

Input Parameters

array
required
Array of sub-requests, each with indexName and objectID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_GET_PURCHASE_RATERetrieve purchase rate metrics for an index, including daily breakdowns, from the US analytics region.

Input Parameters

string
Tags by which to segment the analytics. You can combine multiple tags with OR and AND. Tags must be URL-encoded. For more information, see Algolia’s segment documentation.
string
required
Index name to retrieve purchase rate for.
string
End date of the period to analyze, in YYYY-MM-DD format.
string
Start date of the period to analyze, in YYYY-MM-DD format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_GET_RECOMMEND_RULETool to retrieve a Recommend rule that was previously created in the Algolia dashboard. Use when you need to inspect a specific rule’s configuration, conditions, or consequences by its objectID.

Input Parameters

string ("related-products" | "bought-together" | "trending-facets" | "trending-items")
required
Recommend model type (related-products, bought-together, trending-facets, or trending-items).
string
required
Unique record identifier of the rule to retrieve.
string
required
Name of the index on which to perform the operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_GET_RECOMMEND_TASK_STATUSTool to check the status of a Recommend task. Use when you need to verify if an asynchronous Recommend operation (such as deleting a Recommend rule) has completed.

Input Parameters

string ("related-products" | "bought-together" | "trending-facets" | "trending-items")
required
Recommend model to check task status for. Must be one of: related-products, bought-together, trending-facets, or trending-items.
integer
required
Unique task identifier returned from a previous Recommend operation (e.g., batch recommend rules).
string
required
Name of the index on which to perform the operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_GET_RECORDTool to retrieve a specific record from an index by its objectID. Use when you need to fetch a single object’s details.

Input Parameters

string
required
Unique record identifier.
string
required
Name of the index on which to perform the operation.
array
Attributes to include with the records in the response. This is useful to reduce the size of the API response. By default, all retrievable attributes are returned. objectID is always retrieved. Attributes included in unretrievableAttributes won’t be retrieved unless the request is authenticated with the admin API key.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_GET_REVENUERetrieve search-related revenue data from Algolia Analytics using the US regional endpoint.

Input Parameters

string
Tags by which to segment the analytics. You can combine multiple tags with OR and AND. Tags must be URL-encoded. For more information, see Algolia documentation on segmenting analytics data.
string
required
Index name to retrieve revenue data for.
string
End date of the period to analyze, in YYYY-MM-DD format.
string
Start date of the period to analyze, in YYYY-MM-DD format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_GET_RULETool to retrieve a specific rule by its objectID from an index. Use when you need to inspect a rule’s configuration, conditions, and consequences.

Input Parameters

string
required
Unique identifier of the rule to retrieve.
string
required
Name of the Algolia index to retrieve the rule from.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_GET_SEARCHES_COUNTRetrieve search counts for an index over a time range, including a daily breakdown, using the US regional Analytics endpoint.

Input Parameters

string
Tags by which to segment the analytics. You can combine multiple tags with OR and AND. Tags must be URL-encoded. For more information, see Algolia’s segment documentation.
string
required
Index name to retrieve searches count for.
string
End date of the period to analyze, in YYYY-MM-DD format.
string
Start date of the period to analyze, in YYYY-MM-DD format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_GET_SEARCHES_NO_CLICKSRetrieve top searches without clicks from Algolia Analytics using the US regional endpoint, to help identify queries that may need optimization.

Input Parameters

string
Tags by which to segment the analytics. You can combine multiple tags with OR and AND. Tags must be URL-encoded. For more information, see Algolia’s segment documentation.
string
required
Index name to retrieve no-click searches for.
integer
Number of items to return.
integer
Position of the first item to return.
string
End date of the period to analyze, in YYYY-MM-DD format.
string
Start date of the period to analyze, in YYYY-MM-DD format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_GET_SETTINGSRetrieve selected settings for a specified Algolia index to inspect its configuration.

Input Parameters

string
required
Name of the index whose settings are being retrieved

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_GET_SOURCETool to retrieve a source from the Algolia Ingestion API. Use when you need to get details about a specific data source by its ID.

Input Parameters

string
Region for the Algolia Ingestion API endpoint (e.g., ‘us’, ‘eu’). The API will be called at https://data.&#123;region&#125;.algolia.com
string
required
Unique identifier of the source to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_GET_SYNONYMTool to retrieve a specific synonym by its objectID. Use when you need to fetch details of an existing synonym from an index.

Input Parameters

string
required
Unique identifier of a synonym object.
string
required
Name of the index on which to perform the operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_GET_TASK_STATUSTool to check the status of an asynchronous task. Use when you need to verify completion of operations like adding or deleting records.

Input Parameters

integer
required
Unique task identifier.
string
required
Name of the index on which to perform the operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_GET_TASK_V1Retrieve details of a specific V1 task from the Algolia Ingestion API by task ID. With the standard dashboard connection, requests use the US ingestion endpoint. DEPRECATED: This legacy action is deprecated.

Input Parameters

string
required
Unique identifier of a task.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_GET_TOP_COUNTRIESRetrieve top countries by search volume for a specified index using the US analytics endpoint, to analyze the geographic distribution of searches.

Input Parameters

string
Tags by which to segment the analytics. You can combine multiple tags with OR and AND. Tags must be URL-encoded. For more information, see Algolia’s segment documentation.
string
required
Index name to retrieve top countries for.
integer
Number of items to return.
integer
Position of the first item to return.
string
End date of the period to analyze, in YYYY-MM-DD format.
string
Start date of the period to analyze, in YYYY-MM-DD format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_GET_TOP_FILTER_ATTRIBUTESTool to retrieve top filter attributes from Algolia Analytics. Use when analyzing which filters are most commonly used by users in searches.

Input Parameters

string
Tags by which to segment the analytics. You can combine multiple tags with OR and AND. Tags must be URL-encoded. For more information, see Algolia documentation on segmenting analytics data.
string
required
Name of the Algolia index to retrieve filter attributes for.
integer
Number of items to return.
integer
Position of the first item to return.
Search query to filter results.
string
End date of the period to analyze, in YYYY-MM-DD format.
string
Start date of the period to analyze, in YYYY-MM-DD format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_GET_TOP_FILTER_FOR_ATTRIBUTETool to retrieve top filter values for a specific attribute from Algolia Analytics. Use when analyzing which filter values are most commonly used for a given attribute in search queries.

Input Parameters

string
Tags by which to segment the analytics. You can combine multiple tags with OR and AND. Tags must be URL-encoded. For more information, see Algolia documentation on segmenting analytics data.
string
required
Index name to retrieve filter values from.
integer
Number of items to return. Default is 10.
integer
Position of the first item to return. Default is 0.
string
Search query to filter results.
string
End date of the period to analyze, in YYYY-MM-DD format.
string
required
Attribute name to retrieve top filter values for.
string
Start date of the period to analyze, in YYYY-MM-DD format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_GET_TOP_FILTERS_NO_RESULTSTool to retrieve top filters for searches that returned no results from Algolia Analytics. Use when analyzing which filters are commonly applied to searches that yield zero results, helping identify potential catalog or filtering issues.

Input Parameters

string
Tags by which to segment the analytics. You can combine multiple tags with OR and AND. Tags must be URL-encoded. For more information, see Algolia’s segment documentation.
string
required
Index name to retrieve top filters for searches with no results.
integer
Number of items to return.
integer
Position of the first item to return.
string
Search query string to filter results.
string
End date of the period to analyze, in YYYY-MM-DD format.
string
Start date of the period to analyze, in YYYY-MM-DD format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_GET_TOP_HITSTool to retrieve the object IDs of the most frequent search results from Algolia Analytics. Returns up to 1,000 top hits ranked by frequency, optionally including click analytics (CTR, conversion rates) and revenue metrics. Use when analyzing which results appear most often in searches.

Input Parameters

string
Tags by which to segment the analytics. You can combine multiple tags with OR and AND. Tags must be URL-encoded. For more information, see Algolia’s documentation on segmenting analytics data.
string
required
Index name to retrieve top hits for.
integer
Number of items to return. Default is 10, maximum is 1000.
integer
Position of the first item to return. Default is 0.
string
Search query to filter top hits.
string
End date of the period to analyze, in YYYY-MM-DD format.
string
Start date of the period to analyze, in YYYY-MM-DD format.
boolean
Whether to include metrics related to click and conversion events in the response. When true, adds click-through rate, conversion rate, and related metrics.
boolean
Whether to include metrics related to revenue events in the response. When true, adds add-to-cart rate, purchase rate, and revenue metrics.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_GET_TOP_SEARCHESRetrieve popular search queries from Algolia Analytics, with optional click analytics and revenue metrics. Results can be ordered by search count or click-related metrics in ascending or descending order.

Input Parameters

string
Tags by which to segment the analytics. You can combine multiple tags with OR and AND. Tags must be URL-encoded. For more information, see Algolia’s documentation on segmenting analytics data.
string
required
Index name to retrieve top searches for.
integer
Number of items to return. Default is 10.
integer
Position of the first item to return. Default is 0.
string
End date of the period to analyze, in YYYY-MM-DD format.
string ("searchCount" | "clickThroughRate" | "conversionRate" | "averageClickPosition")
Attribute by which to order the response items.
string ("asc" | "desc")
Sorting direction of the results.
string
Start date of the period to analyze, in YYYY-MM-DD format.
boolean
Whether to include metrics related to click and conversion events in the response. When true, adds click-through rate, conversion rate, and click position metrics.
boolean
Whether to include metrics related to revenue events in the response. When true, adds add-to-cart rate, purchase rate, and revenue metrics.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_GET_TRANSFORMATIONTool to retrieve a transformation by its ID from Algolia’s Ingestion API. Use when you need to fetch details about a specific transformation including its code, configuration, and metadata.

Input Parameters

string
Algolia ingestion API region. Valid values: ‘us’, ‘eu’.
string
required
Unique identifier (UUID) of the transformation to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_GET_USAGETool to retrieve Algolia usage statistics over a specified time period. Use when you need to analyze search operations, indexing operations, capacity metrics, or other usage data for an Algolia application. Requires Premium plan or Enterprise add-on access.

Input Parameters

string
required
End date for the statistics period in ISO 8601 timestamp format. Must be in format: YYYY-MM-DDTHH:MM:SS.sssZ (e.g., ‘2026-02-12T23:59:59.999Z’). Required parameter for all usage queries.
string
required
Start date for the statistics period in ISO 8601 timestamp format. Must be in format: YYYY-MM-DDTHH:MM:SS.sssZ (e.g., ‘2026-02-05T00:00:00.000Z’). Required parameter for all usage queries.
string
required
Type of statistic to retrieve. Can be a single metric or comma-separated list of metrics. Common metrics include: ‘search_operations’, ‘total_search_requests’, ‘queries_operations’, ‘multi_queries_operations’, ‘records’, ‘data_size’, ‘file_size’, ‘max_qps’, ‘used_search_capacity’, ‘avg_processing_time’, ‘90p_processing_time’, ‘99p_processing_time’. Use ’*’ to retrieve all available metrics grouped by category.
string ("hourly" | "daily")
Time granularity for the statistics. Must be either ‘hourly’ (max 7 days range) or ‘daily’ (max 365 days range). Defaults to ‘daily’ if not specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_GET_USAGE_FOR_INDEXRetrieve usage statistics for a specific Algolia index over a time period, with hourly or daily aggregation, including metrics such as record counts, query volumes, and processing times. Usage API access requires a Premium plan or Enterprise add-on.

Input Parameters

string
required
Upper bound timestamp in ISO 8601 format (e.g., ‘2026-02-12T23:59:59Z’). Defines the end of the time period for which to retrieve statistics.
string
required
The name of the index for which to retrieve usage statistics.
string
required
Lower bound timestamp in ISO 8601 format (e.g., ‘2026-01-13T00:00:00Z’). Defines the start of the time period for which to retrieve statistics.
string
required
One or more comma-separated metric names to retrieve. Valid values include: queries_operations, records, data_size, avg_processing_time, 90p_processing_time, 99p_processing_time, multi_queries_operations, acl_operations, total_synonym_operations, total_rules_operations, max_qps, region_max_qps, degraded_queries_ssd_used_queries_impact, used_search_capacity, and more. Multiple statistics can be requested by separating them with commas (e.g., ‘records,avg_processing_time’).
string ("hourly" | "daily")
Granularity of usage data aggregation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_GET_USERSRetrieve user profiles and affinities from Algolia advanced personalization using the EU endpoint. Filter by date ranges and paginate through user data.

Input Parameters

integer
Limit the number of users in the response. The value of this parameter ranges from 1 to 1000.
string
Filter users by end date and time, in RFC 3339 format. Only users that were updated before this date will be returned.
array
Filter users by matching indices. If multiple indices are passed, returned users will match all indices.
array
Filter users by affinity name and value. If multiple values are passed, returned users will match all values.
string
Filter users by start date and time, in RFC 3339 format. Only users that were updated after this date will be returned.
string
Reference for the next page, when navigating forward using pagination. Can’t be used in the same request as previousPageToken.
string
Reference for the previous page, when navigating backward using pagination. Can’t be used in the same request as nextPageToken.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_GET_USERS_COUNTRetrieve the number of unique users for an index over a time range, including a daily breakdown, using the US Algolia Analytics endpoint.

Input Parameters

string
Tags by which to segment the analytics. You can combine multiple tags with OR and AND. Tags must be URL-encoded. For more information, see Algolia’s documentation on segment analytics data.
string
required
Index name to retrieve user count for.
string
End date of the period to analyze, in YYYY-MM-DD format. If omitted, defaults to current date.
string
Start date of the period to analyze, in YYYY-MM-DD format. If omitted, defaults to 30 days before current date.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_INDEX_EXISTSTool to check if an Algolia index exists. Use before performing index operations to prevent accidental index creation. Results are scoped to the Algolia app ID configured in the Composio connection. Example: IndexExists(index_name=‘products’).

Input Parameters

string
required
Name of the Algolia index to check (e.g., ‘products’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_INIT_INSIGHTSReturn Insights client configuration for a selected region, including the application ID, API key, host, and cookie-setting metadata.

Input Parameters

string ("us" | "eu")
Insights API endpoint region: ‘us’ for insights.algolia.io or ‘eu’ for insights.eu.algolia.com.
Whether to store the userToken in a cookie for subsequent calls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_LIST_AB_TESTSList a page of A/B tests for the application in the DE analytics region, with optional index prefix or suffix filters. Results include test IDs and status.

Input Parameters

integer
Number of items to return. Maximum is 1000.
integer
Position of the first item to return. Use for pagination.
string
Index name prefix. Only A/B tests for indices starting with this string are included in the response.
string
Index name suffix. Only A/B tests for indices ending with this string are included in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_LIST_API_KEYSList the application’s main API keys with their permissions and restrictions for access-control review.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_LIST_AUTHENTICATIONSList a page of Algolia ingestion authentication resources in the US region, with optional type and platform filters.

Input Parameters

integer
Page number of the paginated API response. Must be at least 1.
string ("name" | "type" | "platform" | "updatedAt" | "createdAt")
Sort field options for listing authentications.
array
Type of authentication resource to retrieve. Can include multiple types such as ‘basic’, ‘oauth’, etc.
string ("asc" | "desc")
Sort order options.
array
Ecommerce platform for which to retrieve authentications. Can include multiple platforms such as ‘commercetools’, ‘none’, etc.
integer
Number of items per page. Must be between 1 and 100.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_LIST_DESTINATIONSList a page of Algolia ingestion destinations using the US endpoint, optionally filtering by type, authentication ID or transformation ID.

Input Parameters

integer
Page number of the paginated API response.
string ("name" | "type" | "updatedAt" | "createdAt")
Enum for sort properties.
array
Destination type to filter by. Can specify multiple types.
string ("asc" | "desc")
Enum for sort order.
integer
Number of items per page.
array
Authentication ID used by destinations. Can specify multiple IDs.
string
Get the list of destinations used by a transformation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_LIST_INDICESTool to list all indices and their metadata. Use when you need to retrieve index names, sizes, and state before performing operations that depend on index properties.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_LIST_INGESTION_TASKSList ingestion tasks using the US ingestion endpoint. Supports filtering by source, destination, trigger type, action, and enabled status, with pagination and sorting.

Input Parameters

integer
Page number of the paginated API response (1-indexed).
string ("enabled" | "triggerType" | "action" | "updatedAt" | "createdAt")
Property by which to sort the list of tasks.
string ("asc" | "desc")
Sort order of the response.
array
Actions for filtering the list of tasks. Possible values: save, replace, partial, append.
boolean
Filter the list of tasks by the enabled status. Set to true for enabled tasks, false for disabled.
array
Source IDs for filtering the list of tasks. Provide a list of source UUIDs.
array
Filters the tasks with the specified source type. Example: json, commercetools.
array
Type of task trigger for filtering. Possible values: onDemand, schedule, subscription, streaming.
integer
Number of items per page. Must be between 1 and 100. Default is 10.
array
Destination IDs for filtering the list of tasks. Provide a list of destination UUIDs.
boolean
Filter tasks by email notification settings. If specified, only returns tasks with notifications.email.enabled set to this value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_LIST_QS_CONFIGSTool to retrieve all Query Suggestions configurations for an Algolia application. Use when you need to view or audit existing Query Suggestions setups.

Input Parameters

string ("us" | "eu")
required
Analytics region for your Algolia application. Must be ‘us’ or ‘eu’. Check your region in the Infrastructure > Analytics section of the Algolia dashboard.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_LIST_RUNSList Algolia Ingestion task runs using the US regional endpoint. Filter by time range or status and paginate through run history.

Input Parameters

integer
Page number of the paginated API response.
string ("status" | "updatedAt" | "createdAt")
Property by which to sort the list of task runs.
array
Run type for filtering the list of task runs.
string ("asc" | "desc")
Sort order for the list of task runs.
array
Run status for filtering the list of task runs.
string
Task ID for filtering the list of task runs.
string
Date and time for the latest run to retrieve, in RFC 3339 format. By default, the current day is used.
string
Date and time for the earliest run to retrieve, in RFC 3339 format. By default, the current day minus seven days is used.
integer
Number of items per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_LIST_SOURCESTool to list sources from the Algolia Ingestion API. Use when you need to retrieve available data sources for ingestion pipelines. Supports filtering by type and authentication ID, with pagination and sorting options.

Input Parameters

integer
Page number of the paginated API response (1-indexed).
string ("name" | "type" | "updatedAt" | "createdAt")
Property by which to sort the list of sources.
array
Source type filter. Some sources require authentication. Example: [‘commercetools’, ‘bigcommerce’]
string ("asc" | "desc")
Sort order of the response.
string
Algolia ingestion API region. Valid values: ‘us’, ‘eu’, ‘de’.
integer
Number of items per page. Must be between 1 and 100.
array
Authentication IDs of the sources to retrieve. Use ‘none’ to return sources without authentication.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_LIST_TRANSFORMATIONSTool to list all transformations in Algolia Ingestion API. Use when you need to retrieve transformation configurations, filter by type, or paginate through transformation lists.

Input Parameters

integer
Page number of the paginated API response. Must be at least 1.
string ("name" | "updatedAt" | "createdAt")
Sort property for transformations list.
string ("code" | "noCode")
Type of transformation.
string ("asc" | "desc")
Sort order for transformations list.
integer
Number of items per page. Must be between 1 and 100. Defaults to 10.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_PARTIAL_UPDATE_OBJECTSPartially update multiple records in an index by objectID without replacing entire records. Each update can also be configured to create the record if it does not exist.

Input Parameters

array
required
List of objects to update. Each entry must include objectID and any additional fields you wish to change; you can also set createIfNotExists per object.
string
required
Name of the Algolia index where the objects live.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_PUSH_TASKPush records and a selected indexing action to a configured ingestion task by task ID, including actions to delete records, clear an index, or delete an index. Tasks with source type ‘json’ cannot use this endpoint.

Input Parameters

boolean
When true, the push operation will be synchronous and the API will wait for the ingestion to finish before responding.
string ("addObject" | "updateObject" | "partialUpdateObject" | "partialUpdateObjectNoCreate" | "deleteObject" | "delete" | "clear")
required
Which indexing operation to perform: - addObject: adds records to an index (with auto-generated object ID) - updateObject: adds or replaces records in an index - partialUpdateObject: adds or updates attributes (creates if not exists) - partialUpdateObjectNoCreate: same as partialUpdateObject but doesn’t create new records - deleteObject: delete records from an index - delete: delete an index - clear: delete all records from an index
string
required
Unique identifier of the task (UUID format).
array
required
Array of records to push. Each record must include an ‘objectID’ field. Additional fields depend on your index schema. Note: tasks with source type ‘json’ cannot use the push endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_REPLACE_ALL_RULESBatch save rules in an index, replacing existing rules by default. The replacement can also be forwarded to replica indices, and additional request options can override the replacement setting.

Input Parameters

array
required
Array of rule objects to replace all existing rules.
string
required
Name of the Algolia index to replace rules for.
object
Additional request options sent as query parameters.
boolean
Also apply the replacement to replica indices.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_REPLACE_TASKReplace an Algolia Ingestion task with new configuration using the US regional API endpoint.

Input Parameters

string
Cron expression for the task’s schedule.
object
Configuration of the task, depending on its type. Can be streaming input (with mapping), docker streams (with streams array), or Shopify input (with metafields and market).
string ("replace" | "save" | "partial" | "partialNoCreate" | "append")
required
Action to perform on the Algolia index.
string
Date and time when the last cursor was created, in RFC 3339 format.
string
required
Unique identifier of a task.
boolean
Whether the task is enabled.
object
Set of rules for a task.
string
required
Universally unique identifier (UUID) of a destination resource.
object
Notification settings for a task.
integer
Maximum accepted percentage of failures for a task run to finish successfully.
string ("replace" | "save" | "partial" | "partialNoCreate" | "append")
Action to perform on the Algolia index.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_RESTORE_API_KEYTool to restore a deleted API key within 72 hours of deletion. Use when you need to recover an accidentally deleted API key.

Input Parameters

string
required
The API key to restore. Must have been deleted within the last 72 hours.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_RUN_TASK_V1Manually trigger a V1 Algolia Ingestion task using the US regional endpoint. This action is deprecated.

Input Parameters

string
required
Unique identifier of a task.
object
Additional information that will be passed to the created run.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_SAVE_RULETool to create or replace a rule in an index. Use when you need to add merchandising rules, query modifications, or conditional search behavior.

Input Parameters

boolean
Whether the rule is active. Defaults to true.
array
Time periods when the rule is active, specified as Unix timestamps.
string
required
Unique identifier for the rule. This will be used as the rule’s objectID.
array
List of conditions that trigger the rule. Some consequences don’t require conditions. Max 25 conditions.
string
required
Name of the index in which to save the rule.
object
required
Effect of the rule when conditions are met. Must include at least one consequence property.
string
Human-readable description of the rule’s purpose.
boolean
Whether to apply changes to replica indices. Defaults to false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_SAVE_SYNONYMTool to add or update a synonym in the specified index. Use when you need programmatic upsert of search synonyms after index creation.

Input Parameters

object
required
Synonym object payload defining type and values.
string
required
Unique identifier for the synonym object. Must be specified and match the synonym objectID.
string
required
Name of the index in which to save the synonym.
boolean
Whether to forward the synonym update to all replicas.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_SAVE_SYNONYMSBatch create or replace synonyms in an Algolia index. An optional setting replaces all existing synonyms with the supplied batch and can forward changes to replicas.

Input Parameters

array
required
List of synonym objects to create or replace. Each must have an objectID and type.
string
required
Name of the index on which to perform the operation.
boolean
Whether changes are applied to replica indices. Default is false.
boolean
Whether to replace all synonyms in the index with the ones sent with this request. Default is false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_SEARCH_AUTHENTICATIONSTool to search for authentication resources by IDs in Algolia. Use when you need to retrieve multiple specific authentication configurations by their IDs.

Input Parameters

array
required
List of authentication IDs (UUIDs) to search for. Must contain at least one ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_SEARCH_DESTINATIONSSearch for multiple Algolia ingestion destinations by their IDs using the US endpoint.

Input Parameters

array
required
List of destination IDs (UUIDs) to search for. At least one destination ID must be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_SEARCH_DICTIONARY_ENTRIESTool to search dictionary entries in Algolia dictionaries. Use when you need to find stopwords, plurals, or compound words in specific dictionaries.

Input Parameters

integer
Page of search results to retrieve (zero-based).
string
Search query string to match dictionary entries. Empty string returns all entries.
string ("af" | "ar" | "az" | "bg" | "bn" | "ca" | "cs" | "cy" | "da" | "de" | "el" | "en" | "eo" | "es" | "et" | "eu" | "fa" | "fi" | "fo" | "fr" | "ga" | "gl" | "he" | "hi" | "hu" | "hy" | "id" | "is" | "it" | "ja" | "ka" | "kk" | "ko" | "ku" | "ky" | "lt" | "lv" | "mi" | "mn" | "mr" | "ms" | "mt" | "nb" | "nl" | "no" | "ns" | "pl" | "ps" | "pt" | "pt-br" | "qu" | "ro" | "ru" | "sk" | "sq" | "sv" | "sw" | "ta" | "te" | "th" | "tl" | "tn" | "tr" | "tt" | "uk" | "ur" | "uz" | "zh")
Enum for ISO codes of supported languages.
integer
Number of hits per page. Minimum 1, maximum 1000.
string ("plurals" | "stopwords" | "compounds")
required
Dictionary type in which to search: ‘plurals’, ‘stopwords’, or ‘compounds’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_SEARCH_FACET_VALUESTool to search for values of a specified facet attribute. Use when you need to find specific facet values that match a query string. Facet values are sorted by decreasing count by default.

Input Parameters

string
Search parameters as a URL-encoded query string.
string
required
Facet attribute in which to search for values. This attribute must be included in the ‘attributesForFaceting’ index setting with the ‘searchable()’ modifier.
string
required
Name of the index on which to perform the operation.
string
Text to search inside the facet’s values.
integer
Maximum number of facet values to return when searching for facet values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_SEARCH_INDEXTool to perform a search on a specified Algolia index. Use after confirming the index name. Example: SearchIndex(index_name=‘contacts’, query=‘apple’, search_params={‘hitsPerPage’:10})

Input Parameters

string
required
Search query string. Empty string fetches all records. Max length is 512 characters. When searching by URL, strip query params and fragments to match stored paths; validate hits by comparing the URL field to the full target URL.
string
required
Name of the Algolia index to search (e.g., ‘contacts’)
object
Additional Algolia search parameters as key-value pairs, e.g., {‘hitsPerPage’: 10, ‘filters’: ‘category:book’}.
object
Optional request-level options such as extra headers or query params.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_SEARCH_MULTIPLE_INDICESTool to perform searches across multiple indices in a single call. Use when you need to batch multiple index queries into one API request.

Input Parameters

array
required
List of search queries to perform on multiple indices.
string ("none" | "stopIfEnoughMatches")
Search strategy to use: ‘none’ or ‘stopIfEnoughMatches’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_SEARCH_RECOMMEND_RULESSearch Recommend rules in a specified index and model. An empty query can list rules for the recommendation scenario; results are paginated.

Input Parameters

integer
Requested page of the API response. Page numbering starts at 0.
string ("related-products" | "bought-together" | "trending-facets" | "trending-items")
required
Recommend model type (related-products, bought-together, trending-facets, or trending-items).
string
Search query to filter rules. Use an empty string to list all rules for this recommendation scenario.
array
Include facets and facet values in the response. Use [’*’] to include all facets.
string
Only search for rules with matching context.
boolean
Whether to only show rules where the value of their enabled property matches this parameter. If absent, show all rules, regardless of their enabled property.
string
Filter expression. This only searches for rules matching the filter expression.
string
required
Name of the index on which to perform the operation.
integer
Maximum number of hits per page (1-1000). Algolia uses page and hitsPerPage to control how search results are displayed.
integer
Maximum number of values to return for each facet (1-1000).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_SEARCH_SOURCESSearch for multiple Algolia Ingestion API sources by their IDs using the US ingestion endpoint.

Input Parameters

array
required
List of source IDs (UUIDs) to search for. Must contain at least one ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_SEARCH_SYNONYMSSearch synonyms in a specified Algolia index, optionally matching a query or filtering by synonym type. Choose a zero-based page and page size to browse matching synonym entries.

Input Parameters

integer
Zero-based page number to retrieve.
string ("oneWaySynonym" | "synonym" | "placeholder" | "altCorrection1" | "altCorrection2")
Filter by synonym type: ‘oneWaySynonym’, ‘synonym’, ‘placeholder’, ‘altCorrection1’, or ‘altCorrection2’.
string
Keywords to match in synonyms.
string
required
Name of the Algolia index to search for synonyms.
integer
Number of synonyms to return per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_SEARCH_TASKS_V1Search for V1 Algolia Ingestion API tasks by their IDs using the US ingestion endpoint. This tool is deprecated.

Input Parameters

array
required
List of task UUIDs to search for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_SEARCH_TRANSFORMATIONSTool to search for transformations by IDs in Algolia Ingestion API. Use when you need to retrieve multiple specific transformation configurations by their IDs.

Input Parameters

array
required
List of transformation IDs (UUIDs) to search for. Must contain at least one ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_SET_DICTIONARY_SETTINGSTool to update dictionary settings for Algolia. Use when you need to enable or disable built-in stop words, plurals, or compounds for specific languages.

Input Parameters

object
required
Configuration for disabling or enabling built-in Algolia dictionary entries (stopwords, plurals, compounds) for specific languages.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_SET_PERSONALIZATION_STRATEGYTool to define personalization strategy that controls how user behavior affects search results. Use when you need to configure which events and facets influence personalized search rankings.

Input Parameters

string
Algolia personalization API region. Valid values: ‘us’, ‘eu’.
array
required
Scores associated with each event. The higher the scores, the higher the impact of those events on the personalization of search results.
array
required
Scores associated with each facet. The higher the scores, the higher the impact of those facets on the personalization of search results.
integer
required
Impact of personalization on the search results. If set to 0, personalization has no impact on the search results. Value must be between 0 and 100.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_SET_SETTINGSTool to update an Algolia index’s settings. Use when you need to configure index behavior before indexing records. Example: set searchableAttributes and customRanking for products index.

Input Parameters

object
required
Key/value mapping of settings parameters. Only specified keys are overridden; unspecified keys remain unchanged. Use null to reset a setting to its default.
string
required
Name of the index to update.
boolean
Whether to forward these settings to all existing replica indices. Replicas must already exist; cannot create and forward in a single call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_STOP_AB_TESTTool to stop an A/B test by its unique identifier. Use when you need to halt an active A/B test. Note that stopped A/B tests cannot be restarted.

Input Parameters

integer
required
Unique A/B test identifier.
string
Algolia analytics API region. Valid values: ‘us’, ‘de’. Defaults to ‘de’ (EU region).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_TRY_TRANSFORMATIONTool to try a transformation before creating it in Algolia. Use when you need to test transformation code or no-code configurations against sample data to verify they work correctly before deployment.

Input Parameters

string
Deprecated field. The transformation code as a string. Use ‘input’ field with proper ‘type’ instead. If provided without ‘type’ or ‘input’, this will be used for backward compatibility.
string ("code" | "noCode")
Type of transformation.
string
The input for the transformation. Use TransformationCodeInput for code-based transformations or TransformationNoCodeInput for no-code transformations. Required if ‘code’ field is not provided.
object
required
The record to apply the transformation to. This is the sample data that will be transformed. Should be a JSON object representing your data structure.
array
Optional array of authentication resources to use with the transformation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_TRY_TRANSFORMATION_BEFORE_UPDATETool to test a transformation before updating it in Algolia Ingestion API. Use when you need to validate transformation code or configuration against sample data before applying it to production.

Input Parameters

string
(Deprecated) Transformation code. Use the ‘input’ field with proper ‘type’ instead.
string ("code" | "noCode")
Type of transformation to test.
string
The transformation input, which can be either code or no-code configuration. If provided, this will be used to test the transformation.
object
required
The sample record object to apply the transformation to. Must be a valid JSON object.
array
Optional array of authentication configurations for the transformation.
string
required
Unique identifier (UUID) of the transformation to test.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_UPDATE_API_KEYTool to update the permissions and settings of an existing API key. Use when you need to modify ACL permissions, index restrictions, rate limits, or other settings of an existing API key.

Input Parameters

array
required
Permissions that determine the type of API requests this key can make. The required ACL is listed in each endpoint’s reference. For more information, see access control list (ACL).
string
required
The API key to update.
array
Index names or patterns that this API key can access. By default, an API key can access all indices in the same application. You can use leading and trailing wildcard characters (): ‘dev_’ matches all indices starting with ‘dev_’, ‘_dev’ matches all indices ending with ‘_dev’, ‘products*’ matches all indices containing ‘products’.
array
Allowed HTTP referrers for this API key. By default, all referrers are allowed. You can use leading and trailing wildcard characters (): ‘https://algolia.com/’ allows all referrers starting with ‘https://algolia.com/’, ‘*.algolia.com’ allows all referrers ending with ‘.algolia.com’, ‘algolia.com’ allows all referrers in the domain ‘algolia.com’. Like all HTTP headers, referrers can be spoofed. Don’t rely on them to secure your data.
integer
Duration (in seconds) after which the API key expires. By default, API keys don’t expire.
string
Description of an API key to help you identify this API key.
integer
Maximum number of results this API key can retrieve in one query. By default, there’s no limit.
string
Query parameters to add when making API requests with this API key. To restrict this API key to specific IP addresses, add the restrictSources parameter. You can only add a single source, but you can provide a range of IP addresses.
integer
Maximum number of API requests allowed per IP address or user token per hour. If this limit is reached, the API returns an error with status code 429. By default, there’s no limit.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_UPDATE_AUTHENTICATIONUpdate the name or credentials of an Algolia ingestion authentication resource in the US region.

Input Parameters

string
Descriptive name for the resource.
object
Authentication credentials object. The structure varies based on the authentication type. Can include fields like clientEmail/privateKey (googleServiceAccount), username/password (basic), key (apiKey), client_id/client_secret/code/scope/url (oauth), apiKey/appID (algolia), or custom key-value pairs.
string
required
Unique identifier of an authentication resource.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_UPDATE_CONFIGTool to update an existing Query Suggestions configuration. Use when you need to modify settings for query suggestions on an existing index.

Input Parameters

string ("us" | "eu")
Analytics region for your Algolia application (us or eu). Must match your application’s analytics region configured in the Algolia dashboard under Infrastructure > Analytics
array
List of words or regular expressions to exclude from query suggestions
string
required
Name of the Query Suggestions index to update
string
Languages for deduplicating singular/plural suggestions. Set to true to enable for all languages, or provide an array of specific language codes (e.g., [‘en’, ‘fr’])
array
required
Array of source index configurations to use for generating query suggestions. At least one source index is required
boolean
Whether to enable personalized query suggestions based on user behavior. Default is false
boolean
Whether to include suggestions with special characters. Default is false

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_UPDATE_DESTINATIONUpdate an Algolia ingestion destination using the US endpoint, including its configuration, name, type or associated transformations.

Input Parameters

string
Descriptive name for the resource.
string ("search" | "insights")
Destination type enum.
object
Input configuration for updating a destination.
string
required
Unique identifier of a destination.
string
Universally unique identifier (UUID) of an authentication resource.
array
List of transformation IDs to associate with the destination.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_UPDATE_DICTIONARY_ENTRIESBatch add or delete entries in an Algolia stopwords, plurals, or compounds dictionary. The request can also replace all existing custom entries in the selected dictionary.

Input Parameters

array
required
List of add or delete operations to perform on the dictionary entries.
string ("plurals" | "stopwords" | "compounds")
required
Type of dictionary to modify: ‘plurals’ for plural forms, ‘stopwords’ for common words to exclude, ‘compounds’ for compound word handling.
boolean
Whether to replace all existing custom entries in the dictionary with the ones in this request. Default is false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_UPDATE_RECORD_PARTIALLYTool to add or update attributes in a single record. Use when you need to modify specific fields without replacing the entire record. Creates a new record if the objectID doesn’t exist (when create_if_not_exists is true).

Input Parameters

string
required
Unique record identifier.
object
required
Attributes to add or update in the record. Existing attributes with the same keys will be overwritten, new attributes will be added, and unspecified attributes remain unchanged.
string
required
Name of the index on which to perform the operation.
boolean
Whether to create a new record if it doesn’t exist. If true, creates the record when objectID is not found. If false, only updates existing records.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_UPDATE_SOURCETool to update a source in the Algolia Ingestion API. Use when you need to modify the name, authentication, or input configuration of an existing data source.

Input Parameters

string
Descriptive name of the source.
object
Input configuration for the source. The structure varies based on source type. Common fields include: url (string), projectID (string), datasetID (string), tablePrefix (string), table (string), customSQLRequest (string), uniqueIDColumn (string), method (string), delimiter (string), mapping (object), customFields (object), fallbackIsInStockValue (boolean), locales (array), productQueryPredicate (string), storeKeys (array), useImagesObjects (boolean), configuration (object), featureFlags (object).
string
Region for the Algolia Ingestion API endpoint (e.g., ‘us’, ‘eu’). The API will be called at https://data.&#123;region&#125;.algolia.com
string
required
Unique identifier of the source to update.
string
Universally unique identifier (UUID) of an authentication resource.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_UPDATE_TASKPartially update an Algolia Ingestion API task using the US ingestion endpoint. Configure fields such as schedule, failure threshold, destination, or notifications.

Input Parameters

string
Cron expression for the task’s schedule.
object
Configuration of the task, depending on its type. Can be streaming input (with mapping), docker streams (with streams array), or Shopify input (with metafields and market).
string
required
Unique identifier of a task.
boolean
Whether the task is enabled.
object
Set of rules for a task.
string
Universally unique identifier (UUID) of a destination resource.
object
Notification settings for a task.
integer
Maximum accepted percentage of failures for a task run to finish successfully.
string ("replace" | "save" | "partial" | "partialNoCreate" | "append")
Action to perform on the Algolia index. Valid values: replace, save, partial, partialNoCreate, append.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_UPDATE_TRANSFORMATIONTool to update an existing transformation in Algolia Ingestion API. Use when you need to modify transformation settings, code, or configuration for data processing during ingestion.

Input Parameters

string
Deprecated field. Use the ‘input’ field with proper ‘type’ instead to specify the transformation code.
string
required
The uniquely identified name of your transformation.
string ("code" | "noCode")
Type of transformation.
object
The input for the transformation, which can be either code or a no-code configuration.
string
A descriptive name for your transformation explaining what it does.
string
required
Unique identifier (UUID) of the transformation to update.
array
The authentications (UUIDs) associated with the transformation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_VALIDATE_SOURCETool to validate a source payload before creating it in Algolia. Use when you need to verify that a source configuration is valid before actually creating the source.

Input Parameters

string
required
Descriptive name for the source.
string ("bigcommerce" | "bigquery" | "commercetools" | "csv" | "docker" | "ga4BigqueryExport" | "json" | "shopify" | "push")
required
Type of the data source to validate.
object
Input configuration for the source. The structure varies based on source type. Common fields include: url (string), projectID (string), datasetID (string), tablePrefix (string), table (string), customSQLRequest (string), uniqueIDColumn (string), method (string), delimiter (string), mapping (object), customFields (object/array), fallbackIsInStockValue (boolean), locales (array), productQueryPredicate (string), storeKeys (array), useImagesObjects (boolean), configuration (object), image (string), channel (object), productMetafields (array), variantMetafields (array), dataType (string), storeHash (string), projectKey (string).
string ("us" | "eu")
Region for the Algolia Ingestion API endpoint. The API will be called at https://data.&#123;region&#125;.algolia.com
string
Universally unique identifier (UUID) of an authentication resource.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALGOLIA_VALIDATE_SOURCE_BEFORE_UPDATETool to validate a source update payload in the Algolia Ingestion API. Use when you need to verify that an update to a source configuration is valid before actually updating it.

Input Parameters

string
Descriptive name of the source to validate.
object
Input configuration for the source. The structure varies based on source type. Common fields include: url (string), projectID (string), datasetID (string), tablePrefix (string), table (string), customSQLRequest (string), uniqueIDColumn (string), method (string), delimiter (string), mapping (object), customFields (object), fallbackIsInStockValue (boolean), locales (array), productQueryPredicate (string), storeKeys (array), useImagesObjects (boolean), configuration (object), featureFlags (object).
string
Region for the Algolia Ingestion API endpoint (e.g., ‘us’, ‘eu’). The API will be called at https://data.&#123;region&#125;.algolia.com
string
required
Unique identifier of the source to validate.
string
Universally unique identifier (UUID) of an authentication resource.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not