Requirements Algolia requires an active account and an API access token from your account settings to connect. Both are set up on its own site.[3] https://www.algolia.com
Get your Algolia credentials Application ID text Required In the dashboard open Settings, API Keys. The application ID is the ten-character code shown there.[1]
API Key password Required Use the Admin API key, or a key that has the permissions of the modules you use (for example search, add records, settings, analytics). The help of each module names the permission it needs.[1]
Region select Required The region of your Analytics data, shown under Settings, Infrastructure in the dashboard. It picks the Analytics, Insights, A/B testing, Ingestion, Query Suggestions and Personalization servers.[1]
Connect Algolia in WEXTL Log in to your WEXTL account, add the Algolia node module to your workflow, and click Create new credential . Optional: In the Credential name field, enter a name for the credential. Enter the authentication credentials you copied from your Algolia account, or follow the on-screen instructions to create the credential. If prompted, authenticate your account and confirm access. If you want to make changes to your credential in the future, follow the steps in Manage credentials → Notes Credentials are org-scoped. Share them with teammates from the Credentials picker on any of its nodes. For detailed information on connecting an application, see Connect an application →
Algolia triggers and actions on WEXTL The list below is a reference of every Algolia node module the integration supports. You will be able to pick any of them on the workflow canvas while building automations.
Browse every Algolia node module below. Each one opens to show its input parameters, outputs, and connection requirements.
Browse Records Search Walks through the full content of an index. Input fields[3] Field Type IndexRequired
choice LimitRequired
number Query text Filters text Attributes To Retrieve array Attributes To Retrieve text Parameters (JSON) text
Output fields[3] Field Type Object ID text Highlight Result text Snippet Result text Ranking Info object Filters number First Matched Word number Geo Distance number Geo Precision number Matched Geo Location text Personalization text Nb Exact Words number Nb Typos number Promoted boolean Proximity Distance number Distinct Seq ID number
Estimate an A/B Test Search Predicts how long a test must run. Input fields[3] Field Type ConfigurationRequired
text VariantsRequired
text
Output fields[3] Field Type Duration Days number Sample Sizes array Sample Sizes Item number
Get a Destination Search Configuration of a data target. Input fields[3] Field Type DestinationRequired
choice
Output fields[3] Field Type Destination ID text Type text Name text Owner text Input object Index Name text Record Type text Attributes To Exclude array Created At text Updated At text Authentication ID text
1 other output field
Get a Personalization Profile Search What Algolia knows about one user. Input fields[3] Field Type User TokenRequired
text
Output fields[3] Field Type User Token text Last Event At text Scores text
Get a Query Suggestions Config Search Settings behind a suggestions index. Input fields[3] Field Type IndexRequired
choice
Output fields[3] Field Type App ID text Index Name text Source Indices array Source Indices Item object Languages array Languages Item text Exclude array Exclude Item text Enable Personalization boolean Allow Special Characters boolean
Get a Recommend Rule Search One rule from a recommendation model. Input fields[3] Field Type IndexRequired
choice ModelRequired
choice Object IDRequired
text
Output fields[3] Field Type Metadata object Last Update text Object ID text Condition object Filters text Context text Consequence object Hide array Promote array Params object Description text Enabled boolean Validity array Validity Item object
Get a Recommend Task Search Progress of a recommendation write. Input fields[3] Field Type IndexRequired
choice ModelRequired
choice Task IDRequired
text
Output fields[3] Field Type Status text
Get a Record Search One stored record with chosen attributes. Input fields[3] Field Type IndexRequired
choice Object IDRequired
text Attributes To Retrieve array Attributes To Retrieve text
Output fields[3] Field Type Object ID text Name text Price number
Get a Rule Search Query rule definition and state. Input fields[3] Field Type IndexRequired
choice Object IDRequired
text
Output fields[3] Field Type Object ID text Conditions array Conditions Item object Consequence object Params object Promote array Filter Promotes boolean Hide array Redirect object User Data object Description text Enabled boolean Validity array Validity Item object Tags array Tags Item text Scope text
1 other output field
Get a Synonym Search Synonym definition for a query term. Input fields[3] Field Type IndexRequired
choice Object IDRequired
text
Output fields[3] Field Type Object ID text Type text Synonyms array Synonyms Item text Input text Word text Corrections array Corrections Item text Placeholder text Replacements array Replacements Item text
Get a Task Search Configuration of one scheduled ingestion job. Input fields[3] Field Type TaskRequired
choice
Output fields[3] Field Type Task ID text Source ID text Destination ID text Cron text Last Run text Next Run text Owner text Input object Mapping object
9 other output fields
Get a Task Run Search State of a single ingestion run. Input fields[3] Field Type Run IDRequired
text
Output fields[3] Field Type Run ID text App ID text Task ID text Status text Progress object Expected Nb Of Events number Received Nb Of Events number Outcome text Failure Threshold number Reason text
5 other output fields
Get a Task Run Event Search Details of one event inside an ingestion run. Input fields[3] Field Type Run IDRequired
text Event IDRequired
text
Output fields[3] Field Type Event ID text Run ID text Status text Type text Batch Size number Data text Published At text
Get a Transformation Search Definition of a record reshaping script. Input fields[3] Field Type TransformationRequired
choice
Output fields[3] Field Type Transformation ID text Authentication IDs array Authentication IDs Item text Code text Type text Input object Code text Name text Description text Owner text
2 other output fields
Get A/B Test Settings Search Variant configuration of an experiment. Input fields[3] Field Type A/B TestRequired
choice
Output fields[3] Field Type Abtest Settings array Abtest Settings Item object Control Index In Use boolean
Get A/B Test Timeseries Search Day by day results of a test. Input fields[3] Field Type A/B TestRequired
choice Start Date date End Date date Metric choice Methods choice
Output fields[3] Field Type Ab Test ID number Variants array Variants Item object
Get an A/B Test Search Everything recorded for one experiment. Input fields[3] Field Type A/B TestRequired
choice Methods choice
Output fields[3] Field Type Ab Test ID number Updated At text Created At text End At text Stopped At text Name text Hypothesis text Status text
3 other output fields
Get an API Key Search Permissions and limits of a single key. Input fields[3] Field Type API KeyRequired
choice
Output fields[3] Field Type Created At number Acl array Acl Item text Description text Indexes array Indexes Item text Max Hits Per Query number Max Queries Per IPPer Hour number Query Parameters text Referers array Referers Item text
1 other output field
Get an Application Task Search Progress of one application write task. Input fields[3] Field Type Task IDRequired
text
Output fields[3] Field Type Status text
Get an Authentication Search Saved access details for ingestion. Input fields[3] Field Type AuthenticationRequired
choice
Output fields[3] Field Type Authentication ID text Type text Name text Platform text Owner text Input object Client Email text Private Key text Created At text Updated At text
Get an Index Task Search Progress of a write task on an index. Input fields[3] Field Type IndexRequired
choice Task IDRequired
text
Output fields[3] Field Type Status text
Get an Ingestion Source Search Settings of a registered data feed. Input fields[3] Field Type Ingestion SourceRequired
choice
Output fields[3] Field Type Source ID text Type text Name text Owner text Input object Store Keys array Locales array Url text Project Key text Fallback Is In Stock Value boolean Product Query Predicate text Use Images Objects boolean Custom Fields object Authentication ID text Created At text Updated At text
Get Analytics Update Status Search Freshness of the analytics data for an index. Input fields[3] Field Type IndexRequired
choice
Output fields[3] Field Type Updated At text
Get Click Positions Search Clicks grouped by result position. Input fields[3] Field Type IndexRequired
choice Start Date date End Date date Tags text
Output fields[3] Field Type Position array Position Item number Click Count number
Get Cluster Status Search Health reading for the clusters listed. Input fields[3] Field Type ClustersRequired
text
Output fields[3] Field Type Status object C16-De text
Get Dictionary Settings Search Dictionary behaviour for your application. Output fields[3] Field Type Disable Standard Entries object Plurals object Stopwords object Compounds object
Get Index Settings Search Full configuration of an index. Input fields[3] Field Type IndexRequired
choice Get Version number
Output fields[3] Field Type Attributes For Faceting array Attributes For Faceting Item text Replicas array Replicas Item text Pagination Limited To number Unretrievable Attributes array Unretrievable Attributes Item text Disable Typo Tolerance On Words array Disable Typo Tolerance On Words Item text Attributes To Transliterate array Attributes To Transliterate Item text Camel Case Attributes array Camel Case Attributes Item text Decompounded Attributes object De array
55 other output fields
Get Multiple Records Search Many records, possibly from different indexes. Input fields[3] Field Type RequestsRequired
text
Output fields[3] Field Type Ok boolean
Get Query Suggestions Config Status Search Build state of a suggestions index. Input fields[3] Field Type IndexRequired
choice
Output fields[3] Field Type Index Name text Is Running boolean Last Built At text Last Successful Built At text Last Successful Build Duration number
Get Recommendations Search Recommended items for given records. Input fields[3] Field Type RequestsRequired
text
Output fields[3] Field Type Ab Test ID number Ab Test Variant ID number Around Lat Lng text Automatic Radius text Exhaustive object Facets Count boolean Facet Values boolean Nb Hits boolean Rules Match boolean Typo boolean Applied Rules array Applied Rules Item object Exhaustive Facets Count boolean Exhaustive Nb Hits boolean
23 other output fields
Get the Add-to-Cart Rate Search Add-to-cart share across tracked searches. Input fields[3] Field Type IndexRequired
choice Start Date date End Date date Tags text
Output fields[3] Field Type Rate number Tracked Search Count number Add To Cart Count number Dates array Dates Item object
Get the Average Click Position Search Average rank of clicked results. Input fields[3] Field Type IndexRequired
choice Start Date date End Date date Tags text
Output fields[3] Field Type Average number Click Count number Dates array Dates Item object
Get the Click-Through Rate Search Share of searches that led to clicks. Input fields[3] Field Type IndexRequired
choice Start Date date End Date date Tags text
Output fields[3] Field Type Rate number Click Count number Tracked Search Count number Dates array Dates Item object
Get the Cluster Status Overview Search Health snapshot for all clusters. Output fields[3] Field Type Status object C16-De text
Get the Conversion Rate Search Conversion share across tracked searches. Input fields[3] Field Type IndexRequired
choice Start Date date End Date date Tags text
Output fields[3] Field Type Rate number Tracked Search Count number Conversion Count number Dates array Dates Item object
Get the No Click Rate Search Rate of searches nobody clicked on. Input fields[3] Field Type IndexRequired
choice Start Date date End Date date Tags text
Output fields[3] Field Type Rate number Count number No Click Count number Dates array Dates Item object
Get the No Results Rate Search Share of searches that found nothing. Input fields[3] Field Type IndexRequired
choice Start Date date End Date date Tags text
Output fields[3] Field Type Rate number Count number No Result Count number Dates array Dates Item object
Get the Personalization Strategy Search Current personalization settings of the application. Output fields[3] Field Type Events Scoring array Events Scoring Item object Facets Scoring array Facets Scoring Item object Personalization Impact number
Get the Purchase Rate Search Share of searches ending in a sale. Input fields[3] Field Type IndexRequired
choice Start Date date End Date date Tags text
Output fields[3] Field Type Rate number Tracked Search Count number Purchase Count number Dates array Dates Item object
Get the Revenue Search Tracked revenue per currency. Input fields[3] Field Type IndexRequired
choice Start Date date End Date date Tags text
Output fields[3] Field Type Currencies text Dates array Dates Item object
Get the Search Count Search Search volume over time. Input fields[3] Field Type IndexRequired
choice Start Date date End Date date Tags text
Output fields[3] Field Type Count number Dates array Dates Item object
Get the User Count Search Number of unique users over time. Input fields[3] Field Type IndexRequired
choice Start Date date End Date date Tags text
Output fields[3] Field Type Count number Dates array Dates Item object
Get Top Countries Search Countries ranked by searches. Input fields[3] Field Type IndexRequired
choice LimitRequired
number Start Date date End Date date Tags text
Output fields[3] Field Type Country text Count number
Get Top Filter Attributes Search Ranking of the most used facets for filtering. Input fields[3] Field Type IndexRequired
choice LimitRequired
number Search text Start Date date End Date date Tags text
Output fields[3] Field Type Attribute text Count number
Get Top Filter Values Search Popular values of a facet. Input fields[3] Field Type AttributeRequired
text IndexRequired
choice LimitRequired
number Search text Start Date date End Date date Tags text
Output fields[3] Field Type Value text Count number
Get Top Filters Without Results Search Filters that led to empty results. Input fields[3] Field Type IndexRequired
choice LimitRequired
number Search text Start Date date End Date date Tags text
Output fields[3] Field Type Count number Values array Values Item object
Get Top Hits Search Most returned records ranked. Input fields[3] Field Type IndexRequired
choice LimitRequired
number Search text Click Analytics boolean Revenue Analytics boolean Start Date date End Date date Tags text
Output fields[3] Field Type Hit text Count number
Get Top Searches Search Most frequent queries ranked by volume. Input fields[3] Field Type IndexRequired
choice LimitRequired
number Click Analytics boolean Revenue Analytics boolean Start Date date End Date date Order By choice Direction choice
1 other input field
Output fields[3] Field Type Search text Count number Nb Hits number
Get Top Searches Without Clicks Search Queries that nobody clicked through. Input fields[3] Field Type IndexRequired
choice LimitRequired
number Start Date date End Date date Tags text
Output fields[3] Field Type Search text Count number Nb Hits number
Get Top Searches Without Results Search Queries that returned zero hits. Input fields[3] Field Type IndexRequired
choice LimitRequired
number Start Date date End Date date Tags text
Output fields[3] Field Type Search text Count number With Filter Count number
List A/B Tests Search All experiments in the application. Input fields[3] Field Type LimitRequired
number Index Prefix text Index Suffix text Direction choice Methods choice
Output fields[3] Field Type Ab Test ID number Updated At text Created At text End At text Stopped At text Name text Hypothesis text Status text
3 other output fields
List Allowed Sources Search The current allow list. Output fields[3] Field Type Source text Description text
List API Keys Search Each key with its permissions and expiry. Output fields[3] Field Type Created At number Acl array Acl Item text Description text Indexes array Indexes Item text Max Hits Per Query number Max Queries Per IPPer Hour number Query Parameters text Referers array Referers Item text
1 other output field
List Authentications Search Saved ingestion access details. Input fields[3] Field Type LimitRequired
number Type choice Platform choice Sort choice Order choice
Output fields[3] Field Type Authentication ID text Type text Name text Platform text Owner text Input object Client Email text Private Key text Created At text Updated At text
List Cluster Incidents Search Lists incidents logged for clusters, by cluster name. Input fields[3] Field Type ClustersRequired
text
Output fields[3] Field Type Incidents object M134-De array
List Destinations Search Configured ingestion targets with their settings. Input fields[3] Field Type LimitRequired
number Type choice Authentication ID array Authentication ID text Transformation ID text Sort choice Order choice
Output fields[3] Field Type Destination ID text Type text Name text Owner text Input object Index Name text Record Type text Attributes To Exclude array Created At text Updated At text Authentication ID text
1 other output field
List Dictionary Languages Search Languages that dictionaries cover today. Output fields[3] Field Type En object Stopwords object Plurals text Compounds text
List Incidents Search Platform wide incident log. Output fields[3] Field Type Incidents object M134-De array
List Indexes Search Every index with its size and record count. Input fields[3] Field Type LimitRequired
number
Output fields[3] Field Type Name text Created At text Updated At text Entries number Data Size number File Size number Last Build Time S number Number Of Pending Tasks number
6 other output fields
List Ingestion Sources Search Configured ingestion data feeds and their settings. Input fields[3] Field Type LimitRequired
number Type choice Authentication ID array Authentication ID text Sort choice Order choice
Output fields[3] Field Type Source ID text Type text Name text Owner text Input object Store Keys array Locales array Url text Project Key text Fallback Is In Stock Value boolean Product Query Predicate text Use Images Objects boolean Custom Fields text Authentication ID text Created At text Updated At text
List Log Entries Search Recent API request history. Input fields[3] Field Type Offset number Length number Index Name text Type choice
Output fields[3] Field Type Cid text Timestamp text Method text Answer Code text Query Body text Answer text Url text Ip text
8 other output fields
List Query Suggestions Configs Search All suggestion setups with their source indexes. Output fields[3] Field Type App ID text Index Name text Source Indices array Source Indices Item object Languages array Languages Item text Exclude array Exclude Item text Enable Personalization boolean Allow Special Characters boolean
List Query Suggestions Logs Search Build history of a suggestions index. Input fields[3] Field Type IndexRequired
choice
Output fields[3] Field Type Timestamp text Level text Message text Context Level number
List Servers Search Hosts serving the application, by region. Output fields[3] Field Type Name text Region text Is Slave boolean Is Replica boolean Cluster text Status text Type text
List Source Streams Action Streams available from a data source. Input fields[3] Field Type Ingestion SourceRequired
choice
Output fields[3] Field Type Run ID text Event ID text Data array Data Item object Events array Events Item object Message text Created At text
List Task Run Events Search Event log of an ingestion run. Input fields[3] Field Type Run IDRequired
text LimitRequired
number Status choice Type choice Sort choice Order choice Start Date date End Date date
Output fields[3] Field Type Event ID text Run ID text Status text Type text Batch Size number Data text Published At text
List Task Runs Search Execution history of ingestion tasks. Input fields[3] Field Type LimitRequired
number Status choice Type choice Task ID text Sort choice Order choice Start Date date End Date date
Output fields[3] Field Type Run ID text App ID text Task ID text Status text Progress object Expected Nb Of Events number Received Nb Of Events number Outcome text Failure Threshold number Reason text
5 other output fields
List Tasks Search All configured ingestion jobs. Input fields[3] Field Type LimitRequired
number Action choice Enabled choice Source ID array Source ID text Source Type choice Destination ID array Destination ID text Trigger Type choice With Email Notifications choice
2 other input fields
Output fields[3] Field Type Task ID text Source ID text Destination ID text Cron text Last Run text Next Run text Owner text Input object Mapping text
9 other output fields
List Transformations Search Saved record reshaping scripts and their code. Input fields[3] Field Type LimitRequired
number Sort choice Order choice Type choice
Output fields[3] Field Type Transformation ID text Authentication IDs array Authentication IDs Item text Code text Type text Input object Code text Name text Description text Owner text
2 other output fields
Search an Index Search Query an index for matching records. Input fields[3] Field Type IndexRequired
choice Query text Page number Hits Per Page number Filters text Facet Filters text Numeric Filters text Facets array Facet text
9 other input fields
Output fields[3] Field Type Object ID text Highlight Result text Snippet Result text Ranking Info object Filters number First Matched Word number Geo Distance number Geo Precision number Matched Geo Location text Personalization text Nb Exact Words number Nb Typos number Promoted boolean Proximity Distance number Distinct Seq ID number
Search Authentications Search Several stored authentications by ID. Input fields[3] Field Type Authentication IDsRequired
array Authentication ID text
Output fields[3] Field Type Authentication ID text Type text Name text Platform text Owner text Input object Client Email text Private Key text Created At text Updated At text
Search Destinations Search Multiple destinations in a single lookup. Input fields[3] Field Type Destination IDsRequired
array Destination ID text
Output fields[3] Field Type Destination ID text Type text Name text Owner text Input object Index Name text Record Type text Attributes To Exclude array Created At text Updated At text Authentication ID text
1 other output field
Search Dictionary Entries Search Stop word, plural and compound entries for a term. Input fields[3] Field Type DictionaryRequired
choice QueryRequired
text Page number Hits Per Page number Language choice
Output fields[3] Field Type Object ID text Language text Word text Words array Words Item text Decomposition array Decomposition Item text State text Type text
Search Facet Values Search Typeahead for filter values. Input fields[3] Field Type IndexRequired
choice Facet NameRequired
text Params text Facet Query text Max Facet Hits number Parameters (JSON) text
Output fields[3] Field Type Value text Highlighted text Count number
Search Ingestion Sources Search Group lookup of data feeds. Input fields[3] Field Type Source IDsRequired
array Source ID text
Output fields[3] Field Type Source ID text Type text Name text Owner text Input object Store Keys array Locales array Url text Project Key text Fallback Is In Stock Value boolean Product Query Predicate text Use Images Objects boolean Custom Fields object Authentication ID text Created At text Updated At text
Search Multiple Indexes Search Several searches in one request. Input fields[3] Field Type RequestsRequired
text Strategy choice
Output fields[3] Field Type Ab Test ID number Ab Test Variant ID number Around Lat Lng text Automatic Radius text Exhaustive object Facets Count boolean Facet Values boolean Nb Hits boolean Rules Match boolean Typo boolean Applied Rules array Applied Rules Item object Exhaustive Facets Count boolean Exhaustive Nb Hits boolean
26 other output fields
Search Recommend Rules Search Recommendation rules that fit criteria. Input fields[3] Field Type IndexRequired
choice ModelRequired
choice Query text Context text Page number Hits Per Page number Enabled choice Filters text
Output fields[3] Field Type Metadata object Last Update text Object ID text Condition object Filters text Context text Consequence object Hide array Promote array Params text Description text Enabled boolean Validity array Validity Item object
Search Rules Search Rule definitions fitting given criteria. Input fields[3] Field Type IndexRequired
choice Query text Anchoring choice Context text Page number Hits Per Page number Enabled text
Output fields[3] Field Type Object ID text Conditions array Conditions Item object Consequence object Params text Promote array Filter Promotes boolean Hide array Redirect text User Data object Description text Enabled boolean Validity array Validity Item object Tags array Tags Item text Scope text
1 other output field
Search Synonyms Search Alternative terms that fit criteria. Input fields[3] Field Type IndexRequired
choice Query text Type choice Page number Hits Per Page number
Output fields[3] Field Type Object ID text Type text Synonyms array Synonyms Item text Input text Word text Corrections array Corrections Item text Placeholder text Replacements array Replacements Item text
Search Tasks Search Bulk retrieval of ingestion jobs. Input fields[3] Field Type Task IDsRequired
array Task ID text
Output fields[3] Field Type Task ID text Source ID text Destination ID text Cron text Last Run text Next Run text Owner text Input object Mapping object
9 other output fields
Search Transformations Search Group lookup of reshaping scripts. Input fields[3] Field Type Transformation IDsRequired
array Transformation ID text
Output fields[3] Field Type Transformation ID text Authentication IDs array Authentication IDs Item text Code text Type text Input object Code text Name text Description text Owner text
2 other output fields
Add a Record Action Appends a record under a generated identifier. Input fields[3] Field Type IndexRequired
choice Record (JSON)Required
text
Output fields[3] Field Type Created At text Task ID number Object ID text
Add an Allowed Source Action Grants access to one network range. Input fields[3] Field Type SourceRequired
text Description text
Output fields[3] Field Type Created At text
Add or Replace a Record Action Saves a full record at a fixed object ID. Input fields[3] Field Type IndexRequired
choice Object IDRequired
text Record (JSON)Required
text
Output fields[3] Field Type Task ID number Updated At text Object ID text
Apply A/B Test Variant Settings Action Adopts a tested variant on your index. Input fields[3] Field Type A/B TestRequired
choice Variant IDRequired
text
Output fields[3] Field Type Ok boolean
Batch Records in an Index Action Several record writes against one index at once. Input fields[3] Field Type IndexRequired
choice RequestsRequired
text
Output fields[3] Field Type Task ID number Object IDs array Object IDs Item text
Batch Records in Multiple Indexes Action Record writes spread over many indexes in one request. Input fields[3] Field Type RequestsRequired
text
Output fields[3] Field Type Task ID text Object IDs array Object IDs Item text
Copy or Move an Index Action Duplicates an index, or moves it under a new name. Input fields[3] Field Type IndexRequired
choice OperationRequired
choice DestinationRequired
text Scope choice
Output fields[3] Field Type Task ID number Updated At text
Create a Destination Action Adds an ingestion destination. Input fields[3] Field Type TypeRequired
choice NameRequired
text InputRequired
text Authentication ID text Transformation IDs array Transformation ID text
Output fields[3] Field Type Destination ID text Name text Created At text
Create a Query Suggestions Config Action Starts a suggestions setup based on popular searches. Input fields[3] Field Type Source IndicesRequired
text Index Name text Languages array Language text Exclude array Exclude text Enable Personalization boolean Allow Special Characters boolean
Output fields[3] Field Type Status number Message text
Create a Rule Action Writes a single rule at a given object ID. Input fields[3] Field Type IndexRequired
choice Object IDRequired
text ConsequenceRequired
text Forward To Replicas boolean Conditions array Condition object Description text Enabled boolean Validity array Validity object
2 other input fields
Output fields[3] Field Type Task ID number Updated At text
Create a Synonym Action Adds one synonym entry to an index. Input fields[3] Field Type IndexRequired
choice Object IDRequired
text TypeRequired
choice Forward To Replicas boolean Synonyms array Synonym text Input text Word text Corrections array Correction text
2 other input fields
Output fields[3] Field Type Task ID number Updated At text Id text
Create a Task Action Defines a recurring or on-demand ingestion task. Input fields[3] Field Type Source IDRequired
text Destination IDRequired
text ActionRequired
choice Subscription Action choice Cron text Enabled boolean Failure Threshold number Input text
Output fields[3] Field Type Task ID text Created At text
Create a Transformation Action Adds a custom record transformation. Input fields[3] Field Type NameRequired
text Type choice Code text Input text Description text Authentication IDs array Authentication ID text
Output fields[3] Field Type Transformation ID text Created At text
Create an A/B Test Action Starts a test comparing index variants. Input fields[3] Field Type NameRequired
text VariantsRequired
text MetricsRequired
array Metric object End AtRequired
text Hypothesis text Configuration text
Output fields[3] Field Type Index text Ab Test ID number Task ID number
Create an API Key Action Issues a new scoped API key. Input fields[3] Field Type AclRequired
choice Description text Indexes choice Max Hits Per Query number Max Queries Per IPPer Hour number Query Parameters text Referers array Referer text Validity number
Output fields[3] Field Type Created At text
Create an Authentication Action Stores reusable access details for the ingestion pipeline. Input fields[3] Field Type TypeRequired
choice NameRequired
text InputRequired
text Platform choice
Output fields[3] Field Type Authentication ID text Name text Created At text
Create an Ingestion Source Action Adds a data source for ingestion tasks. Input fields[3] Field Type TypeRequired
choice NameRequired
text Input text Authentication ID text
Output fields[3] Field Type Source ID text Name text Created At text
Create Multiple Rules Action Several rules saved together. Input fields[3] Field Type IndexRequired
choice Rules (JSON)Required
text Forward To Replicas boolean Clear Existing Rules boolean
Output fields[3] Field Type Task ID number Updated At text
Create Multiple Synonyms Action Batch write of synonym entries. Input fields[3] Field Type IndexRequired
choice Synonyms (JSON)Required
text Forward To Replicas boolean Replace Existing Synonyms boolean
Output fields[3] Field Type Task ID number Updated At text
Delete a Destination Action Deletes a destination where ingested data lands. Input fields[3] Field Type DestinationRequired
choice
Output fields[3] Field Type Deleted At text
Delete a Personalization Profile Action Clears personalization data held for a single user. Input fields[3] Field Type User TokenRequired
text
Output fields[3] Field Type User Token text Deleted Until text
Delete a Query Suggestions Config Action Removes one suggestions setup. Input fields[3] Field Type IndexRequired
choice
Output fields[3] Field Type Status number Message text
Delete a Recommend Rule Action Removes a rule from a recommendation model. Input fields[3] Field Type IndexRequired
choice ModelRequired
choice Object IDRequired
text
Output fields[3] Field Type Task ID number Deleted At text
Delete a Record Action Deletes one stored record from an index. Input fields[3] Field Type IndexRequired
choice Object IDRequired
text
Output fields[3] Field Type Task ID number Deleted At text
Delete a Rule Action Removes one query rule from an index. Input fields[3] Field Type IndexRequired
choice Object IDRequired
text Forward To Replicas boolean
Output fields[3] Field Type Task ID number Updated At text
Delete a Synonym Action Deletes a synonym entry, optionally on replicas too. Input fields[3] Field Type IndexRequired
choice Object IDRequired
text Forward To Replicas boolean
Output fields[3] Field Type Task ID number Deleted At text
Delete a Task Action Removes an ingestion job definition. Input fields[3] Field Type TaskRequired
choice
Output fields[3] Field Type Deleted At text
Delete a Transformation Action Removes a code transformation. Input fields[3] Field Type TransformationRequired
choice
Output fields[3] Field Type Deleted At text
Delete All Records Action Empties an index of its content. Input fields[3] Field Type IndexRequired
choice
Output fields[3] Field Type Task ID number Updated At text
Delete All Rules Action Empties the rule set of an index. Input fields[3] Field Type IndexRequired
choice Forward To Replicas boolean
Output fields[3] Field Type Task ID number Updated At text
Delete All Synonyms Action Empties the synonym list of an index. Input fields[3] Field Type IndexRequired
choice Forward To Replicas boolean
Output fields[3] Field Type Task ID number Updated At text
Delete an A/B Test Action Deletes a test comparing index variants. Input fields[3] Field Type A/B TestRequired
choice
Output fields[3] Field Type Index text Ab Test ID number Task ID number
Delete an Allowed Source Action Narrows the allow list by one range. Input fields[3] Field Type SourceRequired
text
Output fields[3] Field Type Deleted At text
Delete an API Key Action Cancels a key that was issued earlier. Input fields[3] Field Type API KeyRequired
choice
Output fields[3] Field Type Deleted At text
Delete an Authentication Action Deletes stored access details used by ingestion. Input fields[3] Field Type AuthenticationRequired
choice
Output fields[3] Field Type Deleted At text
Delete an Index Action Removes a whole index. Input fields[3] Field Type IndexRequired
choice
Output fields[3] Field Type Task ID number Deleted At text
Delete an Ingestion Source Action Removes a data feed definition. Input fields[3] Field Type Ingestion SourceRequired
choice
Output fields[3] Field Type Deleted At text
Delete Records by Filter Action Bulk-deletes records that match conditions. Input fields[3] Field Type IndexRequired
choice Filters text Facet Filters text Numeric Filters text Tag Filters text Around Lat Lng text Around RADIUS text Inside Bounding Box text
1 other input field
Output fields[3] Field Type Task ID number Updated At text
Delete User Token Events Action Clears the event history of a single user. Input fields[3] Field Type User TokenRequired
text
Output fields[3] Field Type Ok boolean
Disable a Task Action Pauses an ingestion job. Input fields[3] Field Type TaskRequired
choice
Output fields[3] Field Type Task ID text Updated At text
Enable a Task Action Reactivates an ingestion job. Input fields[3] Field Type TaskRequired
choice
Output fields[3] Field Type Task ID text Updated At text
Make an API Call universal Your own Algolia REST API request. Input fields[3] Field Type ServiceRequired
choice PathRequired
text MethodRequired
choice Headers array Header object Query String array Parameter object Body text
Output fields[3] Field Type Body text Headers object Status code number
Push Records Action Writes records to an index via ingestion. Input fields[3] Field Type IndexRequired
choice ActionRequired
choice RecordsRequired
text Watch choice Reference Index Name text
Output fields[3] Field Type Run ID text Event ID text Data array Data Item object Events array Events Item object Message text Created At text
Push Records to a Task Action Sends records through an existing task. Input fields[3] Field Type TaskRequired
choice ActionRequired
choice RecordsRequired
text Watch choice
Output fields[3] Field Type Run ID text Event ID text Data array Data Item object Events array Events Item object Message text Created At text
Replace a Task Action Swaps a task definition for a new one. Input fields[3] Field Type TaskRequired
choice Destination ID text Action choice Subscription Action choice Cron text Enabled choice Failure Threshold number Input text
1 other input field
Output fields[3] Field Type Task ID text Updated At text
Restore an API Key Action Reinstates a removed key. Input fields[3] Field Type API KeyRequired
choice
Output fields[3] Field Type Created At text
Run a Task Action Starts an ingestion job on demand. Input fields[3] Field Type TaskRequired
choice Run Metadata text
Output fields[3] Field Type Run ID text Created At text
Run Source Tasks Action Triggers all tasks of a data source. Input fields[3] Field Type Ingestion SourceRequired
choice Index To Include array Index To Include text Index To Exclude array Index To Exclude text Entity IDs array Entity ID text Entity Type choice Run Metadata text
Output fields[3] Field Type Task With Run ID text Created At text
Save A/B Test Variant Settings Action Records configuration for a test variant. Input fields[3] Field Type A/B TestRequired
choice Variant IDRequired
text Save Features Settings boolean
Output fields[3] Field Type Ok boolean
Send Events Action Reports user events to Algolia Insights. Input fields[3] Field Type EventsRequired
text
Output fields[3] Field Type Status number Message text
Stop an A/B Test Action Halts a running experiment. Input fields[3] Field Type A/B TestRequired
choice
Output fields[3] Field Type Index text Ab Test ID number Task ID number
Test a Transformation Action Dry run of transformation code. Input fields[3] Field Type Sample RecordRequired
text Type choice Code text Input text Authentications text
Output fields[3] Field Type Payloads array Payloads Item text Error object Code number Message text
Test a Transformation Update Action Preview of edited transformation code. Input fields[3] Field Type TransformationRequired
choice Sample RecordRequired
text Type choice Code text Input text Authentications text
Output fields[3] Field Type Payloads array Payloads Item text Error object Code number Message text
Update a Destination Action Edits an ingestion target. Input fields[3] Field Type DestinationRequired
choice Name text Input text Authentication ID text Transformation IDs array Transformation ID text
Output fields[3] Field Type Destination ID text Name text Updated At text
Update a Query Suggestions Config Action Edits a suggestions setup. Input fields[3] Field Type IndexRequired
choice Source Indices text Languages array Language text Exclude array Exclude text Enable Personalization choice Allow Special Characters choice
Output fields[3] Field Type Status number Message text
Update a Record Action Partial edit of a record. Input fields[3] Field Type IndexRequired
choice Object IDRequired
text Attributes (JSON)Required
text Create If Not Exists boolean
Output fields[3] Field Type Task ID number Updated At text Object ID text
Update a Task Action Edits an ingestion job. Input fields[3] Field Type TaskRequired
choice Destination ID text Cron text Input text Enabled choice Subscription Action choice Failure Threshold number
Output fields[3] Field Type Task ID text Updated At text
Update a Transformation Action Edits a record reshaping script. Input fields[3] Field Type TransformationRequired
choice Name text Type choice Code text Input text Description text Authentication IDs array Authentication ID text
Output fields[3] Field Type Transformation ID text Updated At text
Update Allowed Sources Action Overwrites the set of allowed sources. Input fields[3] Field Type Sources (JSON)Required
text
Output fields[3] Field Type Updated At text
Update an API Key Action Edits permissions of a key. Input fields[3] Field Type API KeyRequired
choice Acl choice Description text Indexes choice Max Hits Per Query number Max Queries Per IPPer Hour number Query Parameters text Referers array Referer text
1 other input field
Output fields[3] Field Type Updated At text
Update an Authentication Action Edits stored access details. Input fields[3] Field Type AuthenticationRequired
choice Name text Input text
Output fields[3] Field Type Authentication ID text Name text Updated At text
Update an Ingestion Source Action Edits a data feed. Input fields[3] Field Type Ingestion SourceRequired
choice Name text Input text Authentication ID text
Output fields[3] Field Type Source ID text Name text Updated At text
Update Dictionary Entries Action Add or remove entries in a dictionary. Input fields[3] Field Type DictionaryRequired
choice RequestsRequired
text Clear Existing Dictionary Entries boolean
Output fields[3] Field Type Task ID number Updated At text
Update Dictionary Settings Action Toggles standard dictionary entries. Input fields[3] Field Type Disable Standard EntriesRequired
text
Output fields[3] Field Type Task ID number Updated At text
Update Index Settings Action Edits search configuration of an index. Input fields[3] Field Type IndexRequired
choice Forward To Replicas boolean Attributes For Faceting array Attributes For Faceting text Searchable Attributes array Searchable Attribute text Ranking array Ranking text Custom Ranking array Custom Ranking text Replicas array Replica text Attributes To Retrieve array Attributes To Retrieve text
9 other input fields
Output fields[3] Field Type Task ID number Updated At text
Update Recommend Rules Action Writes rules for a recommendation model. Input fields[3] Field Type IndexRequired
choice ModelRequired
choice Rules (JSON)Required
text
Output fields[3] Field Type Task ID number Updated At text
Update the Personalization Strategy Action Sets how personalization scores user behaviour. Input fields[3] Field Type Events ScoringRequired
array Events Scoring object Facets ScoringRequired
array Facets Scoring object Personalization ImpactRequired
number
Output fields[3] Field Type Message text
Validate an Ingestion Source Action Tests a source configuration. Input fields[3] Field Type TypeRequired
choice NameRequired
text Input text Authentication ID text
Output fields[3] Field Type Run ID text Event ID text Data array Data Item object Events array Events Item object Message text Created At text
Validate an Ingestion Source Update Action Tests edits to a source. Input fields[3] Field Type Ingestion SourceRequired
choice Name text Input text Authentication ID text
Output fields[3] Field Type Run ID text Event ID text Data array Data Item object Events array Events Item object Message text Created At text
Other database integrations on WEXTL Baserow[2] Open-source database with workspaces, tables, fields, rows and views, managed through the Baserow REST API. Elastic Distributed search and analytics engine for documents, logs, and metrics. Bubble Create, search, update and delete records in the database of a Bubble app. Pinecone Vector database and assistant platform for AI search. Coda Collaborative docs and tables. List and update rows, pages, permissions and Pack data through the Coda API.