Skip to docs navigation

Algolia integration guide

Verified

How to connect Algolia to WEXTL and use its 150 actions in your workflows. About Algolia: Hosted search with indexes, records, settings, rules, synonyms, analytics, A/B tests and data pipelines.

  • 81 searches
  • 69 actions
  • Polling
  • Auth: API key

AI-assisted documentation34 min read

This documentation is compiled from our integration source code, internal specs for Algolia, its official API documentation and anonymized requests logs we collect from our support team[2].

Open Algolia on WEXTL →
  • Algolia
  • WEXTL
  • Baserow
  • Elastic
  • Bubble
  • Pinecone
  • Coda
  • Adalo
  • Softr
  • Milvus
  • NocoDB
  • Knack
  • Qdrant
  • Ninox
  • AWS DynamoDB
  • Kintone
  • Zite
  • Supabase
  • SeaTable
  • Airtable
  • Snowflake
  • FileMaker
  • Zoho Creator
  • Google Firestore
  • Google BigQuery
  • Firebase
  • Tuya
  • Application IDtextRequired

    In the dashboard open Settings, API Keys. The application ID is the ten-character code shown there.[1]

  • API KeypasswordRequired

    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]

  • RegionselectRequired

    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]

  1. Log in to your WEXTL account, add the Algolia node module to your workflow, and click Create new credential.
  2. Optional: In the Credential name field, enter a name for the credential.
  3. Enter the authentication credentials you copied from your Algolia account, or follow the on-screen instructions to create the credential.
  4. If prompted, authenticate your account and confirm access.
  5. If you want to make changes to your credential in the future, follow the steps in Manage credentials →

Browse Records

SearchWalks through the full content of an index.
Input fields[3]
FieldType
IndexRequired
choice
LimitRequired
number
Querytext
Filterstext
Attributes To Retrievearray
Attributes To Retrievetext
Parameters (JSON)text
Output fields[3]
FieldType
Object IDtext
Highlight Resulttext
Snippet Resulttext
Ranking Infoobject
Filtersnumber
First Matched Wordnumber
Geo Distancenumber
Geo Precisionnumber
Matched Geo Locationtext
Personalizationtext
Nb Exact Wordsnumber
Nb Typosnumber
Promotedboolean
Proximity Distancenumber
Distinct Seq IDnumber

Estimate an A/B Test

SearchPredicts how long a test must run.
Input fields[3]
FieldType
ConfigurationRequired
text
VariantsRequired
text
Output fields[3]
FieldType
Duration Daysnumber
Sample Sizesarray
Sample Sizes Itemnumber

Get a Destination

SearchConfiguration of a data target.
Input fields[3]
FieldType
DestinationRequired
choice
Output fields[3]
FieldType
Destination IDtext
Typetext
Nametext
Ownertext
Inputobject
Index Nametext
Record Typetext
Attributes To Excludearray
Created Attext
Updated Attext
Authentication IDtext

1other output field

Get a Personalization Profile

SearchWhat Algolia knows about one user.
Input fields[3]
FieldType
User TokenRequired
text
Output fields[3]
FieldType
User Tokentext
Last Event Attext
Scorestext

Get a Query Suggestions Config

SearchSettings behind a suggestions index.
Input fields[3]
FieldType
IndexRequired
choice
Output fields[3]
FieldType
App IDtext
Index Nametext
Source Indicesarray
Source Indices Itemobject
Languagesarray
Languages Itemtext
Excludearray
Exclude Itemtext
Enable Personalizationboolean
Allow Special Charactersboolean

Get a Recommend Rule

SearchOne rule from a recommendation model.
Input fields[3]
FieldType
IndexRequired
choice
ModelRequired
choice
Object IDRequired
text
Output fields[3]
FieldType
Metadataobject
Last Updatetext
Object IDtext
Conditionobject
Filterstext
Contexttext
Consequenceobject
Hidearray
Promotearray
Paramsobject
Descriptiontext
Enabledboolean
Validityarray
Validity Itemobject

Get a Recommend Task

SearchProgress of a recommendation write.
Input fields[3]
FieldType
IndexRequired
choice
ModelRequired
choice
Task IDRequired
text
Output fields[3]
FieldType
Statustext

Get a Record

SearchOne stored record with chosen attributes.
Input fields[3]
FieldType
IndexRequired
choice
Object IDRequired
text
Attributes To Retrievearray
Attributes To Retrievetext
Output fields[3]
FieldType
Object IDtext
Nametext
Pricenumber

Get a Rule

SearchQuery rule definition and state.
Input fields[3]
FieldType
IndexRequired
choice
Object IDRequired
text
Output fields[3]
FieldType
Object IDtext
Conditionsarray
Conditions Itemobject
Consequenceobject
Paramsobject
Promotearray
Filter Promotesboolean
Hidearray
Redirectobject
User Dataobject
Descriptiontext
Enabledboolean
Validityarray
Validity Itemobject
Tagsarray
Tags Itemtext
Scopetext

1other output field

Get a Synonym

SearchSynonym definition for a query term.
Input fields[3]
FieldType
IndexRequired
choice
Object IDRequired
text
Output fields[3]
FieldType
Object IDtext
Typetext
Synonymsarray
Synonyms Itemtext
Inputtext
Wordtext
Correctionsarray
Corrections Itemtext
Placeholdertext
Replacementsarray
Replacements Itemtext

Get a Task

SearchConfiguration of one scheduled ingestion job.
Input fields[3]
FieldType
TaskRequired
choice
Output fields[3]
FieldType
Task IDtext
Source IDtext
Destination IDtext
Crontext
Last Runtext
Next Runtext
Ownertext
Inputobject
Mappingobject

9other output fields

Get a Task Run

SearchState of a single ingestion run.
Input fields[3]
FieldType
Run IDRequired
text
Output fields[3]
FieldType
Run IDtext
App IDtext
Task IDtext
Statustext
Progressobject
Expected Nb Of Eventsnumber
Received Nb Of Eventsnumber
Outcometext
Failure Thresholdnumber
Reasontext

5other output fields

Get a Task Run Event

SearchDetails of one event inside an ingestion run.
Input fields[3]
FieldType
Run IDRequired
text
Event IDRequired
text
Output fields[3]
FieldType
Event IDtext
Run IDtext
Statustext
Typetext
Batch Sizenumber
Datatext
Published Attext

Get a Transformation

SearchDefinition of a record reshaping script.
Input fields[3]
FieldType
TransformationRequired
choice
Output fields[3]
FieldType
Transformation IDtext
Authentication IDsarray
Authentication IDs Itemtext
Codetext
Typetext
Inputobject
Codetext
Nametext
Descriptiontext
Ownertext

2other output fields

Get A/B Test Settings

SearchVariant configuration of an experiment.
Input fields[3]
FieldType
A/B TestRequired
choice
Output fields[3]
FieldType
Abtest Settingsarray
Abtest Settings Itemobject
Control Index In Useboolean

Get A/B Test Timeseries

SearchDay by day results of a test.
Input fields[3]
FieldType
A/B TestRequired
choice
Start Datedate
End Datedate
Metricchoice
Methodschoice
Output fields[3]
FieldType
Ab Test IDnumber
Variantsarray
Variants Itemobject

Get an A/B Test

SearchEverything recorded for one experiment.
Input fields[3]
FieldType
A/B TestRequired
choice
Methodschoice
Output fields[3]
FieldType
Ab Test IDnumber
Updated Attext
Created Attext
End Attext
Stopped Attext
Nametext
Hypothesistext
Statustext

3other output fields

Get an API Key

SearchPermissions and limits of a single key.
Input fields[3]
FieldType
API KeyRequired
choice
Output fields[3]
FieldType
Created Atnumber
Aclarray
Acl Itemtext
Descriptiontext
Indexesarray
Indexes Itemtext
Max Hits Per Querynumber
Max Queries Per IPPer Hournumber
Query Parameterstext
Referersarray
Referers Itemtext

1other output field

Get an Application Task

SearchProgress of one application write task.
Input fields[3]
FieldType
Task IDRequired
text
Output fields[3]
FieldType
Statustext

Get an Authentication

SearchSaved access details for ingestion.
Input fields[3]
FieldType
AuthenticationRequired
choice
Output fields[3]
FieldType
Authentication IDtext
Typetext
Nametext
Platformtext
Ownertext
Inputobject
Client Emailtext
Private Keytext
Created Attext
Updated Attext

Get an Index Task

SearchProgress of a write task on an index.
Input fields[3]
FieldType
IndexRequired
choice
Task IDRequired
text
Output fields[3]
FieldType
Statustext

Get an Ingestion Source

SearchSettings of a registered data feed.
Input fields[3]
FieldType
Ingestion SourceRequired
choice
Output fields[3]
FieldType
Source IDtext
Typetext
Nametext
Ownertext
Inputobject
Store Keysarray
Localesarray
Urltext
Project Keytext
Fallback Is In Stock Valueboolean
Product Query Predicatetext
Use Images Objectsboolean
Custom Fieldsobject
Authentication IDtext
Created Attext
Updated Attext

Get Analytics Update Status

SearchFreshness of the analytics data for an index.
Input fields[3]
FieldType
IndexRequired
choice
Output fields[3]
FieldType
Updated Attext

Get Click Positions

SearchClicks grouped by result position.
Input fields[3]
FieldType
IndexRequired
choice
Start Datedate
End Datedate
Tagstext
Output fields[3]
FieldType
Positionarray
Position Itemnumber
Click Countnumber

Get Cluster Status

SearchHealth reading for the clusters listed.
Input fields[3]
FieldType
ClustersRequired
text
Output fields[3]
FieldType
Statusobject
C16-Detext

Get Dictionary Settings

SearchDictionary behaviour for your application.
Output fields[3]
FieldType
Disable Standard Entriesobject
Pluralsobject
Stopwordsobject
Compoundsobject

Get Index Settings

SearchFull configuration of an index.
Input fields[3]
FieldType
IndexRequired
choice
Get Versionnumber
Output fields[3]
FieldType
Attributes For Facetingarray
Attributes For Faceting Itemtext
Replicasarray
Replicas Itemtext
Pagination Limited Tonumber
Unretrievable Attributesarray
Unretrievable Attributes Itemtext
Disable Typo Tolerance On Wordsarray
Disable Typo Tolerance On Words Itemtext
Attributes To Transliteratearray
Attributes To Transliterate Itemtext
Camel Case Attributesarray
Camel Case Attributes Itemtext
Decompounded Attributesobject
Dearray

55other output fields

Get Multiple Records

SearchMany records, possibly from different indexes.
Input fields[3]
FieldType
RequestsRequired
text
Output fields[3]
FieldType
Okboolean

Get Query Suggestions Config Status

SearchBuild state of a suggestions index.
Input fields[3]
FieldType
IndexRequired
choice
Output fields[3]
FieldType
Index Nametext
Is Runningboolean
Last Built Attext
Last Successful Built Attext
Last Successful Build Durationnumber

Get Recommendations

SearchRecommended items for given records.
Input fields[3]
FieldType
RequestsRequired
text
Output fields[3]
FieldType
Ab Test IDnumber
Ab Test Variant IDnumber
Around Lat Lngtext
Automatic Radiustext
Exhaustiveobject
Facets Countboolean
Facet Valuesboolean
Nb Hitsboolean
Rules Matchboolean
Typoboolean
Applied Rulesarray
Applied Rules Itemobject
Exhaustive Facets Countboolean
Exhaustive Nb Hitsboolean

23other output fields

Get the Add-to-Cart Rate

SearchAdd-to-cart share across tracked searches.
Input fields[3]
FieldType
IndexRequired
choice
Start Datedate
End Datedate
Tagstext
Output fields[3]
FieldType
Ratenumber
Tracked Search Countnumber
Add To Cart Countnumber
Datesarray
Dates Itemobject

Get the Average Click Position

SearchAverage rank of clicked results.
Input fields[3]
FieldType
IndexRequired
choice
Start Datedate
End Datedate
Tagstext
Output fields[3]
FieldType
Averagenumber
Click Countnumber
Datesarray
Dates Itemobject

Get the Click-Through Rate

SearchShare of searches that led to clicks.
Input fields[3]
FieldType
IndexRequired
choice
Start Datedate
End Datedate
Tagstext
Output fields[3]
FieldType
Ratenumber
Click Countnumber
Tracked Search Countnumber
Datesarray
Dates Itemobject

Get the Cluster Status Overview

SearchHealth snapshot for all clusters.
Output fields[3]
FieldType
Statusobject
C16-Detext

Get the Conversion Rate

SearchConversion share across tracked searches.
Input fields[3]
FieldType
IndexRequired
choice
Start Datedate
End Datedate
Tagstext
Output fields[3]
FieldType
Ratenumber
Tracked Search Countnumber
Conversion Countnumber
Datesarray
Dates Itemobject

Get the No Click Rate

SearchRate of searches nobody clicked on.
Input fields[3]
FieldType
IndexRequired
choice
Start Datedate
End Datedate
Tagstext
Output fields[3]
FieldType
Ratenumber
Countnumber
No Click Countnumber
Datesarray
Dates Itemobject

Get the No Results Rate

SearchShare of searches that found nothing.
Input fields[3]
FieldType
IndexRequired
choice
Start Datedate
End Datedate
Tagstext
Output fields[3]
FieldType
Ratenumber
Countnumber
No Result Countnumber
Datesarray
Dates Itemobject

Get the Personalization Strategy

SearchCurrent personalization settings of the application.
Output fields[3]
FieldType
Events Scoringarray
Events Scoring Itemobject
Facets Scoringarray
Facets Scoring Itemobject
Personalization Impactnumber

Get the Purchase Rate

SearchShare of searches ending in a sale.
Input fields[3]
FieldType
IndexRequired
choice
Start Datedate
End Datedate
Tagstext
Output fields[3]
FieldType
Ratenumber
Tracked Search Countnumber
Purchase Countnumber
Datesarray
Dates Itemobject

Get the Revenue

SearchTracked revenue per currency.
Input fields[3]
FieldType
IndexRequired
choice
Start Datedate
End Datedate
Tagstext
Output fields[3]
FieldType
Currenciestext
Datesarray
Dates Itemobject

Get the Search Count

SearchSearch volume over time.
Input fields[3]
FieldType
IndexRequired
choice
Start Datedate
End Datedate
Tagstext
Output fields[3]
FieldType
Countnumber
Datesarray
Dates Itemobject

Get the User Count

SearchNumber of unique users over time.
Input fields[3]
FieldType
IndexRequired
choice
Start Datedate
End Datedate
Tagstext
Output fields[3]
FieldType
Countnumber
Datesarray
Dates Itemobject

Get Top Countries

SearchCountries ranked by searches.
Input fields[3]
FieldType
IndexRequired
choice
LimitRequired
number
Start Datedate
End Datedate
Tagstext
Output fields[3]
FieldType
Countrytext
Countnumber

Get Top Filter Attributes

SearchRanking of the most used facets for filtering.
Input fields[3]
FieldType
IndexRequired
choice
LimitRequired
number
Searchtext
Start Datedate
End Datedate
Tagstext
Output fields[3]
FieldType
Attributetext
Countnumber

Get Top Filter Values

SearchPopular values of a facet.
Input fields[3]
FieldType
AttributeRequired
text
IndexRequired
choice
LimitRequired
number
Searchtext
Start Datedate
End Datedate
Tagstext
Output fields[3]
FieldType
Valuetext
Countnumber

Get Top Filters Without Results

SearchFilters that led to empty results.
Input fields[3]
FieldType
IndexRequired
choice
LimitRequired
number
Searchtext
Start Datedate
End Datedate
Tagstext
Output fields[3]
FieldType
Countnumber
Valuesarray
Values Itemobject

Get Top Hits

SearchMost returned records ranked.
Input fields[3]
FieldType
IndexRequired
choice
LimitRequired
number
Searchtext
Click Analyticsboolean
Revenue Analyticsboolean
Start Datedate
End Datedate
Tagstext
Output fields[3]
FieldType
Hittext
Countnumber

Get Top Searches

SearchMost frequent queries ranked by volume.
Input fields[3]
FieldType
IndexRequired
choice
LimitRequired
number
Click Analyticsboolean
Revenue Analyticsboolean
Start Datedate
End Datedate
Order Bychoice
Directionchoice

1other input field

Output fields[3]
FieldType
Searchtext
Countnumber
Nb Hitsnumber

Get Top Searches Without Clicks

SearchQueries that nobody clicked through.
Input fields[3]
FieldType
IndexRequired
choice
LimitRequired
number
Start Datedate
End Datedate
Tagstext
Output fields[3]
FieldType
Searchtext
Countnumber
Nb Hitsnumber

Get Top Searches Without Results

SearchQueries that returned zero hits.
Input fields[3]
FieldType
IndexRequired
choice
LimitRequired
number
Start Datedate
End Datedate
Tagstext
Output fields[3]
FieldType
Searchtext
Countnumber
With Filter Countnumber

List A/B Tests

SearchAll experiments in the application.
Input fields[3]
FieldType
LimitRequired
number
Index Prefixtext
Index Suffixtext
Directionchoice
Methodschoice
Output fields[3]
FieldType
Ab Test IDnumber
Updated Attext
Created Attext
End Attext
Stopped Attext
Nametext
Hypothesistext
Statustext

3other output fields

List Allowed Sources

SearchThe current allow list.
Output fields[3]
FieldType
Sourcetext
Descriptiontext

List API Keys

SearchEach key with its permissions and expiry.
Output fields[3]
FieldType
Created Atnumber
Aclarray
Acl Itemtext
Descriptiontext
Indexesarray
Indexes Itemtext
Max Hits Per Querynumber
Max Queries Per IPPer Hournumber
Query Parameterstext
Referersarray
Referers Itemtext

1other output field

List Authentications

SearchSaved ingestion access details.
Input fields[3]
FieldType
LimitRequired
number
Typechoice
Platformchoice
Sortchoice
Orderchoice
Output fields[3]
FieldType
Authentication IDtext
Typetext
Nametext
Platformtext
Ownertext
Inputobject
Client Emailtext
Private Keytext
Created Attext
Updated Attext

List Cluster Incidents

SearchLists incidents logged for clusters, by cluster name.
Input fields[3]
FieldType
ClustersRequired
text
Output fields[3]
FieldType
Incidentsobject
M134-Dearray

List Destinations

SearchConfigured ingestion targets with their settings.
Input fields[3]
FieldType
LimitRequired
number
Typechoice
Authentication IDarray
Authentication IDtext
Transformation IDtext
Sortchoice
Orderchoice
Output fields[3]
FieldType
Destination IDtext
Typetext
Nametext
Ownertext
Inputobject
Index Nametext
Record Typetext
Attributes To Excludearray
Created Attext
Updated Attext
Authentication IDtext

1other output field

List Dictionary Languages

SearchLanguages that dictionaries cover today.
Output fields[3]
FieldType
Enobject
Stopwordsobject
Pluralstext
Compoundstext

List Incidents

SearchPlatform wide incident log.
Output fields[3]
FieldType
Incidentsobject
M134-Dearray

List Indexes

SearchEvery index with its size and record count.
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
Nametext
Created Attext
Updated Attext
Entriesnumber
Data Sizenumber
File Sizenumber
Last Build Time Snumber
Number Of Pending Tasksnumber

6other output fields

List Ingestion Sources

SearchConfigured ingestion data feeds and their settings.
Input fields[3]
FieldType
LimitRequired
number
Typechoice
Authentication IDarray
Authentication IDtext
Sortchoice
Orderchoice
Output fields[3]
FieldType
Source IDtext
Typetext
Nametext
Ownertext
Inputobject
Store Keysarray
Localesarray
Urltext
Project Keytext
Fallback Is In Stock Valueboolean
Product Query Predicatetext
Use Images Objectsboolean
Custom Fieldstext
Authentication IDtext
Created Attext
Updated Attext

List Log Entries

SearchRecent API request history.
Input fields[3]
FieldType
Offsetnumber
Lengthnumber
Index Nametext
Typechoice
Output fields[3]
FieldType
Cidtext
Timestamptext
Methodtext
Answer Codetext
Query Bodytext
Answertext
Urltext
Iptext

8other output fields

List Query Suggestions Configs

SearchAll suggestion setups with their source indexes.
Output fields[3]
FieldType
App IDtext
Index Nametext
Source Indicesarray
Source Indices Itemobject
Languagesarray
Languages Itemtext
Excludearray
Exclude Itemtext
Enable Personalizationboolean
Allow Special Charactersboolean

List Query Suggestions Logs

SearchBuild history of a suggestions index.
Input fields[3]
FieldType
IndexRequired
choice
Output fields[3]
FieldType
Timestamptext
Leveltext
Messagetext
Context Levelnumber

List Servers

SearchHosts serving the application, by region.
Output fields[3]
FieldType
Nametext
Regiontext
Is Slaveboolean
Is Replicaboolean
Clustertext
Statustext
Typetext

List Source Streams

ActionStreams available from a data source.
Input fields[3]
FieldType
Ingestion SourceRequired
choice
Output fields[3]
FieldType
Run IDtext
Event IDtext
Dataarray
Data Itemobject
Eventsarray
Events Itemobject
Messagetext
Created Attext

List Task Run Events

SearchEvent log of an ingestion run.
Input fields[3]
FieldType
Run IDRequired
text
LimitRequired
number
Statuschoice
Typechoice
Sortchoice
Orderchoice
Start Datedate
End Datedate
Output fields[3]
FieldType
Event IDtext
Run IDtext
Statustext
Typetext
Batch Sizenumber
Datatext
Published Attext

List Task Runs

SearchExecution history of ingestion tasks.
Input fields[3]
FieldType
LimitRequired
number
Statuschoice
Typechoice
Task IDtext
Sortchoice
Orderchoice
Start Datedate
End Datedate
Output fields[3]
FieldType
Run IDtext
App IDtext
Task IDtext
Statustext
Progressobject
Expected Nb Of Eventsnumber
Received Nb Of Eventsnumber
Outcometext
Failure Thresholdnumber
Reasontext

5other output fields

List Tasks

SearchAll configured ingestion jobs.
Input fields[3]
FieldType
LimitRequired
number
Actionchoice
Enabledchoice
Source IDarray
Source IDtext
Source Typechoice
Destination IDarray
Destination IDtext
Trigger Typechoice
With Email Notificationschoice

2other input fields

Output fields[3]
FieldType
Task IDtext
Source IDtext
Destination IDtext
Crontext
Last Runtext
Next Runtext
Ownertext
Inputobject
Mappingtext

9other output fields

List Transformations

SearchSaved record reshaping scripts and their code.
Input fields[3]
FieldType
LimitRequired
number
Sortchoice
Orderchoice
Typechoice
Output fields[3]
FieldType
Transformation IDtext
Authentication IDsarray
Authentication IDs Itemtext
Codetext
Typetext
Inputobject
Codetext
Nametext
Descriptiontext
Ownertext

2other output fields

Search an Index

SearchQuery an index for matching records.
Input fields[3]
FieldType
IndexRequired
choice
Querytext
Pagenumber
Hits Per Pagenumber
Filterstext
Facet Filterstext
Numeric Filterstext
Facetsarray
Facettext

9other input fields

Output fields[3]
FieldType
Object IDtext
Highlight Resulttext
Snippet Resulttext
Ranking Infoobject
Filtersnumber
First Matched Wordnumber
Geo Distancenumber
Geo Precisionnumber
Matched Geo Locationtext
Personalizationtext
Nb Exact Wordsnumber
Nb Typosnumber
Promotedboolean
Proximity Distancenumber
Distinct Seq IDnumber

Search Authentications

SearchSeveral stored authentications by ID.
Input fields[3]
FieldType
Authentication IDsRequired
array
Authentication IDtext
Output fields[3]
FieldType
Authentication IDtext
Typetext
Nametext
Platformtext
Ownertext
Inputobject
Client Emailtext
Private Keytext
Created Attext
Updated Attext

Search Destinations

SearchMultiple destinations in a single lookup.
Input fields[3]
FieldType
Destination IDsRequired
array
Destination IDtext
Output fields[3]
FieldType
Destination IDtext
Typetext
Nametext
Ownertext
Inputobject
Index Nametext
Record Typetext
Attributes To Excludearray
Created Attext
Updated Attext
Authentication IDtext

1other output field

Search Dictionary Entries

SearchStop word, plural and compound entries for a term.
Input fields[3]
FieldType
DictionaryRequired
choice
QueryRequired
text
Pagenumber
Hits Per Pagenumber
Languagechoice
Output fields[3]
FieldType
Object IDtext
Languagetext
Wordtext
Wordsarray
Words Itemtext
Decompositionarray
Decomposition Itemtext
Statetext
Typetext

Search Facet Values

SearchTypeahead for filter values.
Input fields[3]
FieldType
IndexRequired
choice
Facet NameRequired
text
Paramstext
Facet Querytext
Max Facet Hitsnumber
Parameters (JSON)text
Output fields[3]
FieldType
Valuetext
Highlightedtext
Countnumber

Search Ingestion Sources

SearchGroup lookup of data feeds.
Input fields[3]
FieldType
Source IDsRequired
array
Source IDtext
Output fields[3]
FieldType
Source IDtext
Typetext
Nametext
Ownertext
Inputobject
Store Keysarray
Localesarray
Urltext
Project Keytext
Fallback Is In Stock Valueboolean
Product Query Predicatetext
Use Images Objectsboolean
Custom Fieldsobject
Authentication IDtext
Created Attext
Updated Attext

Search Multiple Indexes

SearchSeveral searches in one request.
Input fields[3]
FieldType
RequestsRequired
text
Strategychoice
Output fields[3]
FieldType
Ab Test IDnumber
Ab Test Variant IDnumber
Around Lat Lngtext
Automatic Radiustext
Exhaustiveobject
Facets Countboolean
Facet Valuesboolean
Nb Hitsboolean
Rules Matchboolean
Typoboolean
Applied Rulesarray
Applied Rules Itemobject
Exhaustive Facets Countboolean
Exhaustive Nb Hitsboolean

26other output fields

Search Recommend Rules

SearchRecommendation rules that fit criteria.
Input fields[3]
FieldType
IndexRequired
choice
ModelRequired
choice
Querytext
Contexttext
Pagenumber
Hits Per Pagenumber
Enabledchoice
Filterstext
Output fields[3]
FieldType
Metadataobject
Last Updatetext
Object IDtext
Conditionobject
Filterstext
Contexttext
Consequenceobject
Hidearray
Promotearray
Paramstext
Descriptiontext
Enabledboolean
Validityarray
Validity Itemobject

Search Rules

SearchRule definitions fitting given criteria.
Input fields[3]
FieldType
IndexRequired
choice
Querytext
Anchoringchoice
Contexttext
Pagenumber
Hits Per Pagenumber
Enabledtext
Output fields[3]
FieldType
Object IDtext
Conditionsarray
Conditions Itemobject
Consequenceobject
Paramstext
Promotearray
Filter Promotesboolean
Hidearray
Redirecttext
User Dataobject
Descriptiontext
Enabledboolean
Validityarray
Validity Itemobject
Tagsarray
Tags Itemtext
Scopetext

1other output field

Search Synonyms

SearchAlternative terms that fit criteria.
Input fields[3]
FieldType
IndexRequired
choice
Querytext
Typechoice
Pagenumber
Hits Per Pagenumber
Output fields[3]
FieldType
Object IDtext
Typetext
Synonymsarray
Synonyms Itemtext
Inputtext
Wordtext
Correctionsarray
Corrections Itemtext
Placeholdertext
Replacementsarray
Replacements Itemtext

Search Tasks

SearchBulk retrieval of ingestion jobs.
Input fields[3]
FieldType
Task IDsRequired
array
Task IDtext
Output fields[3]
FieldType
Task IDtext
Source IDtext
Destination IDtext
Crontext
Last Runtext
Next Runtext
Ownertext
Inputobject
Mappingobject

9other output fields

Search Transformations

SearchGroup lookup of reshaping scripts.
Input fields[3]
FieldType
Transformation IDsRequired
array
Transformation IDtext
Output fields[3]
FieldType
Transformation IDtext
Authentication IDsarray
Authentication IDs Itemtext
Codetext
Typetext
Inputobject
Codetext
Nametext
Descriptiontext
Ownertext

2other output fields

Add a Record

ActionAppends a record under a generated identifier.
Input fields[3]
FieldType
IndexRequired
choice
Record (JSON)Required
text
Output fields[3]
FieldType
Created Attext
Task IDnumber
Object IDtext

Add an Allowed Source

ActionGrants access to one network range.
Input fields[3]
FieldType
SourceRequired
text
Descriptiontext
Output fields[3]
FieldType
Created Attext

Add or Replace a Record

ActionSaves a full record at a fixed object ID.
Input fields[3]
FieldType
IndexRequired
choice
Object IDRequired
text
Record (JSON)Required
text
Output fields[3]
FieldType
Task IDnumber
Updated Attext
Object IDtext

Apply A/B Test Variant Settings

ActionAdopts a tested variant on your index.
Input fields[3]
FieldType
A/B TestRequired
choice
Variant IDRequired
text
Output fields[3]
FieldType
Okboolean

Batch Records in an Index

ActionSeveral record writes against one index at once.
Input fields[3]
FieldType
IndexRequired
choice
RequestsRequired
text
Output fields[3]
FieldType
Task IDnumber
Object IDsarray
Object IDs Itemtext

Batch Records in Multiple Indexes

ActionRecord writes spread over many indexes in one request.
Input fields[3]
FieldType
RequestsRequired
text
Output fields[3]
FieldType
Task IDtext
Object IDsarray
Object IDs Itemtext

Copy or Move an Index

ActionDuplicates an index, or moves it under a new name.
Input fields[3]
FieldType
IndexRequired
choice
OperationRequired
choice
DestinationRequired
text
Scopechoice
Output fields[3]
FieldType
Task IDnumber
Updated Attext

Create a Destination

ActionAdds an ingestion destination.
Input fields[3]
FieldType
TypeRequired
choice
NameRequired
text
InputRequired
text
Authentication IDtext
Transformation IDsarray
Transformation IDtext
Output fields[3]
FieldType
Destination IDtext
Nametext
Created Attext

Create a Query Suggestions Config

ActionStarts a suggestions setup based on popular searches.
Input fields[3]
FieldType
Source IndicesRequired
text
Index Nametext
Languagesarray
Languagetext
Excludearray
Excludetext
Enable Personalizationboolean
Allow Special Charactersboolean
Output fields[3]
FieldType
Statusnumber
Messagetext

Create a Rule

ActionWrites a single rule at a given object ID.
Input fields[3]
FieldType
IndexRequired
choice
Object IDRequired
text
ConsequenceRequired
text
Forward To Replicasboolean
Conditionsarray
Conditionobject
Descriptiontext
Enabledboolean
Validityarray
Validityobject

2other input fields

Output fields[3]
FieldType
Task IDnumber
Updated Attext

Create a Synonym

ActionAdds one synonym entry to an index.
Input fields[3]
FieldType
IndexRequired
choice
Object IDRequired
text
TypeRequired
choice
Forward To Replicasboolean
Synonymsarray
Synonymtext
Inputtext
Wordtext
Correctionsarray
Correctiontext

2other input fields

Output fields[3]
FieldType
Task IDnumber
Updated Attext
Idtext

Create a Task

ActionDefines a recurring or on-demand ingestion task.
Input fields[3]
FieldType
Source IDRequired
text
Destination IDRequired
text
ActionRequired
choice
Subscription Actionchoice
Crontext
Enabledboolean
Failure Thresholdnumber
Inputtext
Output fields[3]
FieldType
Task IDtext
Created Attext

Create a Transformation

ActionAdds a custom record transformation.
Input fields[3]
FieldType
NameRequired
text
Typechoice
Codetext
Inputtext
Descriptiontext
Authentication IDsarray
Authentication IDtext
Output fields[3]
FieldType
Transformation IDtext
Created Attext

Create an A/B Test

ActionStarts a test comparing index variants.
Input fields[3]
FieldType
NameRequired
text
VariantsRequired
text
MetricsRequired
array
Metricobject
End AtRequired
text
Hypothesistext
Configurationtext
Output fields[3]
FieldType
Indextext
Ab Test IDnumber
Task IDnumber

Create an API Key

ActionIssues a new scoped API key.
Input fields[3]
FieldType
AclRequired
choice
Descriptiontext
Indexeschoice
Max Hits Per Querynumber
Max Queries Per IPPer Hournumber
Query Parameterstext
Referersarray
Referertext
Validitynumber
Output fields[3]
FieldType
Created Attext

Create an Authentication

ActionStores reusable access details for the ingestion pipeline.
Input fields[3]
FieldType
TypeRequired
choice
NameRequired
text
InputRequired
text
Platformchoice
Output fields[3]
FieldType
Authentication IDtext
Nametext
Created Attext

Create an Ingestion Source

ActionAdds a data source for ingestion tasks.
Input fields[3]
FieldType
TypeRequired
choice
NameRequired
text
Inputtext
Authentication IDtext
Output fields[3]
FieldType
Source IDtext
Nametext
Created Attext

Create Multiple Rules

ActionSeveral rules saved together.
Input fields[3]
FieldType
IndexRequired
choice
Rules (JSON)Required
text
Forward To Replicasboolean
Clear Existing Rulesboolean
Output fields[3]
FieldType
Task IDnumber
Updated Attext

Create Multiple Synonyms

ActionBatch write of synonym entries.
Input fields[3]
FieldType
IndexRequired
choice
Synonyms (JSON)Required
text
Forward To Replicasboolean
Replace Existing Synonymsboolean
Output fields[3]
FieldType
Task IDnumber
Updated Attext

Delete a Destination

ActionDeletes a destination where ingested data lands.
Input fields[3]
FieldType
DestinationRequired
choice
Output fields[3]
FieldType
Deleted Attext

Delete a Personalization Profile

ActionClears personalization data held for a single user.
Input fields[3]
FieldType
User TokenRequired
text
Output fields[3]
FieldType
User Tokentext
Deleted Untiltext

Delete a Query Suggestions Config

ActionRemoves one suggestions setup.
Input fields[3]
FieldType
IndexRequired
choice
Output fields[3]
FieldType
Statusnumber
Messagetext

Delete a Recommend Rule

ActionRemoves a rule from a recommendation model.
Input fields[3]
FieldType
IndexRequired
choice
ModelRequired
choice
Object IDRequired
text
Output fields[3]
FieldType
Task IDnumber
Deleted Attext

Delete a Record

ActionDeletes one stored record from an index.
Input fields[3]
FieldType
IndexRequired
choice
Object IDRequired
text
Output fields[3]
FieldType
Task IDnumber
Deleted Attext

Delete a Rule

ActionRemoves one query rule from an index.
Input fields[3]
FieldType
IndexRequired
choice
Object IDRequired
text
Forward To Replicasboolean
Output fields[3]
FieldType
Task IDnumber
Updated Attext

Delete a Synonym

ActionDeletes a synonym entry, optionally on replicas too.
Input fields[3]
FieldType
IndexRequired
choice
Object IDRequired
text
Forward To Replicasboolean
Output fields[3]
FieldType
Task IDnumber
Deleted Attext

Delete a Task

ActionRemoves an ingestion job definition.
Input fields[3]
FieldType
TaskRequired
choice
Output fields[3]
FieldType
Deleted Attext

Delete a Transformation

ActionRemoves a code transformation.
Input fields[3]
FieldType
TransformationRequired
choice
Output fields[3]
FieldType
Deleted Attext

Delete All Records

ActionEmpties an index of its content.
Input fields[3]
FieldType
IndexRequired
choice
Output fields[3]
FieldType
Task IDnumber
Updated Attext

Delete All Rules

ActionEmpties the rule set of an index.
Input fields[3]
FieldType
IndexRequired
choice
Forward To Replicasboolean
Output fields[3]
FieldType
Task IDnumber
Updated Attext

Delete All Synonyms

ActionEmpties the synonym list of an index.
Input fields[3]
FieldType
IndexRequired
choice
Forward To Replicasboolean
Output fields[3]
FieldType
Task IDnumber
Updated Attext

Delete an A/B Test

ActionDeletes a test comparing index variants.
Input fields[3]
FieldType
A/B TestRequired
choice
Output fields[3]
FieldType
Indextext
Ab Test IDnumber
Task IDnumber

Delete an Allowed Source

ActionNarrows the allow list by one range.
Input fields[3]
FieldType
SourceRequired
text
Output fields[3]
FieldType
Deleted Attext

Delete an API Key

ActionCancels a key that was issued earlier.
Input fields[3]
FieldType
API KeyRequired
choice
Output fields[3]
FieldType
Deleted Attext

Delete an Authentication

ActionDeletes stored access details used by ingestion.
Input fields[3]
FieldType
AuthenticationRequired
choice
Output fields[3]
FieldType
Deleted Attext

Delete an Index

ActionRemoves a whole index.
Input fields[3]
FieldType
IndexRequired
choice
Output fields[3]
FieldType
Task IDnumber
Deleted Attext

Delete an Ingestion Source

ActionRemoves a data feed definition.
Input fields[3]
FieldType
Ingestion SourceRequired
choice
Output fields[3]
FieldType
Deleted Attext

Delete Records by Filter

ActionBulk-deletes records that match conditions.
Input fields[3]
FieldType
IndexRequired
choice
Filterstext
Facet Filterstext
Numeric Filterstext
Tag Filterstext
Around Lat Lngtext
Around RADIUStext
Inside Bounding Boxtext

1other input field

Output fields[3]
FieldType
Task IDnumber
Updated Attext

Delete User Token Events

ActionClears the event history of a single user.
Input fields[3]
FieldType
User TokenRequired
text
Output fields[3]
FieldType
Okboolean

Disable a Task

ActionPauses an ingestion job.
Input fields[3]
FieldType
TaskRequired
choice
Output fields[3]
FieldType
Task IDtext
Updated Attext

Enable a Task

ActionReactivates an ingestion job.
Input fields[3]
FieldType
TaskRequired
choice
Output fields[3]
FieldType
Task IDtext
Updated Attext

Make an API Call

universalYour own Algolia REST API request.
Input fields[3]
FieldType
ServiceRequired
choice
PathRequired
text
MethodRequired
choice
Headersarray
Headerobject
Query Stringarray
Parameterobject
Bodytext
Output fields[3]
FieldType
Bodytext
Headersobject
Status codenumber

Push Records

ActionWrites records to an index via ingestion.
Input fields[3]
FieldType
IndexRequired
choice
ActionRequired
choice
RecordsRequired
text
Watchchoice
Reference Index Nametext
Output fields[3]
FieldType
Run IDtext
Event IDtext
Dataarray
Data Itemobject
Eventsarray
Events Itemobject
Messagetext
Created Attext

Push Records to a Task

ActionSends records through an existing task.
Input fields[3]
FieldType
TaskRequired
choice
ActionRequired
choice
RecordsRequired
text
Watchchoice
Output fields[3]
FieldType
Run IDtext
Event IDtext
Dataarray
Data Itemobject
Eventsarray
Events Itemobject
Messagetext
Created Attext

Replace a Task

ActionSwaps a task definition for a new one.
Input fields[3]
FieldType
TaskRequired
choice
Destination IDtext
Actionchoice
Subscription Actionchoice
Crontext
Enabledchoice
Failure Thresholdnumber
Inputtext

1other input field

Output fields[3]
FieldType
Task IDtext
Updated Attext

Restore an API Key

ActionReinstates a removed key.
Input fields[3]
FieldType
API KeyRequired
choice
Output fields[3]
FieldType
Created Attext

Run a Task

ActionStarts an ingestion job on demand.
Input fields[3]
FieldType
TaskRequired
choice
Run Metadatatext
Output fields[3]
FieldType
Run IDtext
Created Attext

Run Source Tasks

ActionTriggers all tasks of a data source.
Input fields[3]
FieldType
Ingestion SourceRequired
choice
Index To Includearray
Index To Includetext
Index To Excludearray
Index To Excludetext
Entity IDsarray
Entity IDtext
Entity Typechoice
Run Metadatatext
Output fields[3]
FieldType
Task With Run IDtext
Created Attext

Save A/B Test Variant Settings

ActionRecords configuration for a test variant.
Input fields[3]
FieldType
A/B TestRequired
choice
Variant IDRequired
text
Save Features Settingsboolean
Output fields[3]
FieldType
Okboolean

Send Events

ActionReports user events to Algolia Insights.
Input fields[3]
FieldType
EventsRequired
text
Output fields[3]
FieldType
Statusnumber
Messagetext

Stop an A/B Test

ActionHalts a running experiment.
Input fields[3]
FieldType
A/B TestRequired
choice
Output fields[3]
FieldType
Indextext
Ab Test IDnumber
Task IDnumber

Test a Transformation

ActionDry run of transformation code.
Input fields[3]
FieldType
Sample RecordRequired
text
Typechoice
Codetext
Inputtext
Authenticationstext
Output fields[3]
FieldType
Payloadsarray
Payloads Itemtext
Errorobject
Codenumber
Messagetext

Test a Transformation Update

ActionPreview of edited transformation code.
Input fields[3]
FieldType
TransformationRequired
choice
Sample RecordRequired
text
Typechoice
Codetext
Inputtext
Authenticationstext
Output fields[3]
FieldType
Payloadsarray
Payloads Itemtext
Errorobject
Codenumber
Messagetext

Update a Destination

ActionEdits an ingestion target.
Input fields[3]
FieldType
DestinationRequired
choice
Nametext
Inputtext
Authentication IDtext
Transformation IDsarray
Transformation IDtext
Output fields[3]
FieldType
Destination IDtext
Nametext
Updated Attext

Update a Query Suggestions Config

ActionEdits a suggestions setup.
Input fields[3]
FieldType
IndexRequired
choice
Source Indicestext
Languagesarray
Languagetext
Excludearray
Excludetext
Enable Personalizationchoice
Allow Special Characterschoice
Output fields[3]
FieldType
Statusnumber
Messagetext

Update a Record

ActionPartial edit of a record.
Input fields[3]
FieldType
IndexRequired
choice
Object IDRequired
text
Attributes (JSON)Required
text
Create If Not Existsboolean
Output fields[3]
FieldType
Task IDnumber
Updated Attext
Object IDtext

Update a Task

ActionEdits an ingestion job.
Input fields[3]
FieldType
TaskRequired
choice
Destination IDtext
Crontext
Inputtext
Enabledchoice
Subscription Actionchoice
Failure Thresholdnumber
Output fields[3]
FieldType
Task IDtext
Updated Attext

Update a Transformation

ActionEdits a record reshaping script.
Input fields[3]
FieldType
TransformationRequired
choice
Nametext
Typechoice
Codetext
Inputtext
Descriptiontext
Authentication IDsarray
Authentication IDtext
Output fields[3]
FieldType
Transformation IDtext
Updated Attext

Update Allowed Sources

ActionOverwrites the set of allowed sources.
Input fields[3]
FieldType
Sources (JSON)Required
text
Output fields[3]
FieldType
Updated Attext

Update an API Key

ActionEdits permissions of a key.
Input fields[3]
FieldType
API KeyRequired
choice
Aclchoice
Descriptiontext
Indexeschoice
Max Hits Per Querynumber
Max Queries Per IPPer Hournumber
Query Parameterstext
Referersarray
Referertext

1other input field

Output fields[3]
FieldType
Updated Attext

Update an Authentication

ActionEdits stored access details.
Input fields[3]
FieldType
AuthenticationRequired
choice
Nametext
Inputtext
Output fields[3]
FieldType
Authentication IDtext
Nametext
Updated Attext

Update an Ingestion Source

ActionEdits a data feed.
Input fields[3]
FieldType
Ingestion SourceRequired
choice
Nametext
Inputtext
Authentication IDtext
Output fields[3]
FieldType
Source IDtext
Nametext
Updated Attext

Update Dictionary Entries

ActionAdd or remove entries in a dictionary.
Input fields[3]
FieldType
DictionaryRequired
choice
RequestsRequired
text
Clear Existing Dictionary Entriesboolean
Output fields[3]
FieldType
Task IDnumber
Updated Attext

Update Dictionary Settings

ActionToggles standard dictionary entries.
Input fields[3]
FieldType
Disable Standard EntriesRequired
text
Output fields[3]
FieldType
Task IDnumber
Updated Attext

Update Index Settings

ActionEdits search configuration of an index.
Input fields[3]
FieldType
IndexRequired
choice
Forward To Replicasboolean
Attributes For Facetingarray
Attributes For Facetingtext
Searchable Attributesarray
Searchable Attributetext
Rankingarray
Rankingtext
Custom Rankingarray
Custom Rankingtext
Replicasarray
Replicatext
Attributes To Retrievearray
Attributes To Retrievetext

9other input fields

Output fields[3]
FieldType
Task IDnumber
Updated Attext

Update Recommend Rules

ActionWrites rules for a recommendation model.
Input fields[3]
FieldType
IndexRequired
choice
ModelRequired
choice
Rules (JSON)Required
text
Output fields[3]
FieldType
Task IDnumber
Updated Attext

Update the Personalization Strategy

ActionSets how personalization scores user behaviour.
Input fields[3]
FieldType
Events ScoringRequired
array
Events Scoringobject
Facets ScoringRequired
array
Facets Scoringobject
Personalization ImpactRequired
number
Output fields[3]
FieldType
Messagetext

Validate an Ingestion Source

ActionTests a source configuration.
Input fields[3]
FieldType
TypeRequired
choice
NameRequired
text
Inputtext
Authentication IDtext
Output fields[3]
FieldType
Run IDtext
Event IDtext
Dataarray
Data Itemobject
Eventsarray
Events Itemobject
Messagetext
Created Attext

Validate an Ingestion Source Update

ActionTests edits to a source.
Input fields[3]
FieldType
Ingestion SourceRequired
choice
Nametext
Inputtext
Authentication IDtext
Output fields[3]
FieldType
Run IDtext
Event IDtext
Dataarray
Data Itemobject
Eventsarray
Events Itemobject
Messagetext
Created Attext

Look for Algolia templates in the WEXTL template library.

Browse templates →
  1. WEXTL® Algolia Source Code connector implementation.
  2. Our users use cases and automations.
  3. Official API Documentation for Algolia.
  4. WEXTL® visual workflow builder data.

Last updated: Nov 14, 2026 14:55

How we write our apps documentation

How we compile these docs: sources, the role of AI, and how we verify.