Linking Algolia as a source
This source is currently in alpha. The interface and available tables may change.
The Algolia connector syncs your Algolia search data – index records, synonyms, query rules, and indices – into PostHog, so you can analyze your search configuration alongside your product data.
Prerequisites
You need an Algolia account with access to your Application ID and the ability to create an API key with the ACLs for the data you want to sync.
Adding a data source
- In PostHog, go to the Sources tab of the data pipeline section.
- Click + New source and click Link next to this source.
- Enter your credentials (see Configuration below) and click Next.
- Select the tables you want to sync, choose a sync method and frequency, then click Import.
Once the syncs are complete, you can start querying this data in PostHog.
When linking Algolia, you'll need:
- Application ID – found in your Algolia dashboard under your account API keys.
- API key – create one in the same Algolia dashboard. Grant the ACLs for the data you want to sync:
browsefor index records,settingsfor synonyms and query rules, andlistIndexesfor the list of indices. - Index name – the name of the Algolia index you want to sync.
Sync modes
Each table can be synced in one of several modes, depending on what the source supports:
- Webhook (when available) – the source pushes changes to PostHog in real time. Fastest freshness, lowest ongoing cost, and the only mode that reliably captures updates and deletes.
- Incremental – only new or updated rows are synced on each run, using a cursor field (such as an
updated_attimestamp). Cheaper than a full refresh, but deletes aren't captured. - Append only – new rows are appended using a cursor field; existing rows are never updated. Ideal for immutable, append-only tables like event logs.
- Full refresh – the whole table is reloaded on every sync. Use it when a table has no reliable cursor or when you need deletions reflected.
See sync methods for a full explanation of how each mode works and how to choose between them.
Algolia endpoints do not expose a server-side updated-since filter, so this source is full refresh only.
Configuration
| Option | Type | Required |
|---|---|---|
Application ID | text | Yes |
API key | password | Yes |
Index name | text | Yes |
Supported tables
The tables available from this source are discovered from your account when you connect it, so the exact list depends on your data. Once connected, you can pick which tables to sync from the sources tab.
Troubleshooting
- If you see an authentication error, check that your Application ID and API key are correct in the Algolia dashboard.
- If a table fails to sync, make sure your API key has the ACL required for it:
browsefor records,settingsfor synonyms and query rules, andlistIndexesfor indices.
If your sync is failing or data looks wrong, see the Data warehouse troubleshooting guide. If that doesn't help, contact support – we're happy to help.