API_KEY
algolia_api_key
Developer setup
No fields declared in this snapshot.
User connection
- Algolia API Keygeneric_api_key · stringRequired
- Algolia Application IDgeneric_id · stringRequired
ALGOLIA
Algolia is a hosted search API that provides developers with tools to build fast and relevant search experiences for their applications.
Description is untrusted, display-only upstream metadata. It never becomes policy, OAuth scope authority, or an agent instruction.
Pakkawork boundary
Research catalogue metadata only. No Pakkawork OAuth, credential, host, quota, executor, or verifier is enabled.
133
Action summaries
Display-only definitions
0
Trigger types
Not installed instances
1
Auth modes
Field names, never values
No
Execution
No runtime adapter
Authentication map
API_KEY
No fields declared in this snapshot.
Capability index
Showing 61–90 of 133 actions
ALGOLIA_GET_PURCHASE_RATE
Tool to retrieve purchase rate metrics for searches that led to purchase events. Use when you need to analyze conversion effectiveness and purchase behavior for an index, including daily breakdowns.
Untrusted display-only summary
ALGOLIA_GET_RECOMMEND_RULE
Tool 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.
Untrusted display-only summary
ALGOLIA_GET_RECOMMEND_TASK_STATUS
Tool 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.
Untrusted display-only summary
ALGOLIA_GET_RECORD
Tool to retrieve a specific record from an index by its objectID. Use when you need to fetch a single object's details.
Untrusted display-only summary
ALGOLIA_GET_REVENUE
Tool to retrieve revenue data from Algolia Analytics. Use when analyzing revenue metrics and conversion tracking for search results.
Untrusted display-only summary
ALGOLIA_GET_RULE
Tool to retrieve a specific rule by its objectID from an index. Use when you need to inspect a rule's configuration, conditions, and consequences.
Untrusted display-only summary
ALGOLIA_GET_SEARCHES_COUNT
Tool to retrieve the number of searches within a time range, including a daily breakdown. Use when analyzing search volume and traffic patterns for an index.
Untrusted display-only summary
ALGOLIA_GET_SEARCHES_NO_CLICKS
Tool to retrieve top searches that did not receive any clicks. Use when analyzing search queries that may need optimization, such as queries with poor results or missing content.
Untrusted display-only summary
ALGOLIA_GET_SETTINGS
Tool to retrieve the settings of a specified index. Use when you need to inspect index configurations after creation or update.
Untrusted display-only summary
ALGOLIA_GET_SOURCE
Tool to retrieve a source from the Algolia Ingestion API. Use when you need to get details about a specific data source by its ID.
Untrusted display-only summary
ALGOLIA_GET_SYNONYM
Tool to retrieve a specific synonym by its objectID. Use when you need to fetch details of an existing synonym from an index.
Untrusted display-only summary
ALGOLIA_GET_TASK_STATUS
Tool to check the status of an asynchronous task. Use when you need to verify completion of operations like adding or deleting records.
Untrusted display-only summary
ALGOLIA_GET_TASK_V1
Tool to retrieve a task V1 from Algolia Ingestion API. Use when you need to fetch details about a specific task. Note: This API is deprecated but still functional.
Untrusted display-only summary
ALGOLIA_GET_TOP_COUNTRIES
Tool to retrieve top countries by search volume for a specified index. Use when you need to analyze geographic distribution of searches and understand where your users are searching from.
Untrusted display-only summary
ALGOLIA_GET_TOP_FILTER_ATTRIBUTES
Tool to retrieve top filter attributes from Algolia Analytics. Use when analyzing which filters are most commonly used by users in searches.
Untrusted display-only summary
ALGOLIA_GET_TOP_FILTER_FOR_ATTRIBUTE
Tool 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.
Untrusted display-only summary
ALGOLIA_GET_TOP_FILTERS_NO_RESULTS
Tool 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.
Untrusted display-only summary
ALGOLIA_GET_TOP_HITS
Tool 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.
Untrusted display-only summary
ALGOLIA_GET_TOP_SEARCHES
Tool to retrieve the most popular searches from Algolia Analytics. Returns search queries ranked by frequency, optionally including click analytics (CTR, conversion rates) and revenue metrics. Use when analyzing search behavior and identifying trending queries.
Untrusted display-only summary
ALGOLIA_GET_TRANSFORMATION
Tool 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.
Untrusted display-only summary
ALGOLIA_GET_USAGE
Tool 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.
Untrusted display-only summary
ALGOLIA_GET_USAGE_FOR_INDEX
Tool to retrieve usage statistics for a specific Algolia index over a time period. Use when you need to analyze index metrics such as record counts, query volumes, processing times, or capacity usage. Supports both hourly and daily aggregation granularity.
Untrusted display-only summary
ALGOLIA_GET_USERS
Tool to retrieve a list of user profiles from Algolia advanced personalization. Use when you need to fetch user affinities, filter by date ranges, or paginate through user data.
Untrusted display-only summary
ALGOLIA_GET_USERS_COUNT
Tool to retrieve the number of unique users within a time range, including daily breakdown. Use when you need to analyze user engagement metrics for a specific index over a date range.
Untrusted display-only summary
ALGOLIA_INDEX_EXISTS
Tool 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 provider-directory connection. Example: IndexExists(index_name='products').
Untrusted display-only summary
ALGOLIA_INIT_INSIGHTS
Tool to initialize the Algolia Insights API client. Use before sending any Insights events.
Untrusted display-only summary
ALGOLIA_LIST_AB_TESTS
Tool to list all A/B tests configured for this application. Use when you need to view existing A/B tests, check their status, or retrieve test IDs for further operations.
Untrusted display-only summary
ALGOLIA_LIST_API_KEYS
Tool to list all API keys associated with your Algolia application, including their permissions and restrictions. Use when you need to audit API key usage, check permissions, or manage access control.
Untrusted display-only summary
ALGOLIA_LIST_AUTHENTICATIONS
Tool to list authentication resources from Algolia. Use when you need to retrieve available authentication configurations for sources or destinations.
Untrusted display-only summary
ALGOLIA_LIST_DESTINATIONS
Tool to list destinations in Algolia. Use when you need to retrieve all destinations or filter them by type, authentication ID, or transformation ID.
Untrusted display-only summary
Provenance
The detail snapshot comes from an attributed MIT-licensed repository revision. Safe local icons use exact-match CC0 Simple Icons symbols; unmatched brands use monograms.
Remote text is plain display metadata only. It must never become an agent prompt, execution policy, OAuth grant, or executable instruction.