Linking ClickHouse Cloud as a source

Alpha release

This source is currently in alpha. The interface and available tables may change.

The ClickHouse Cloud connector syncs your organization's data from the ClickHouse Cloud API – daily usage costs, service inventory, backups, members, API keys, and the audit log – into PostHog, so you can build cost, chargeback, and capacity dashboards alongside your product data.

This connector reads from ClickHouse Cloud's management API. To sync data stored inside a ClickHouse database, use the ClickHouse source instead.

Prerequisites

You need a ClickHouse Cloud organization and an API key. Generate one in the ClickHouse Cloud console under your organization's API keys settings. Keys with the Admin role can read every table; a Developer-scoped key may not have access to the usage cost and audit log tables.

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 ClickHouse Cloud, you'll need:

API key ID – the key ID generated in the ClickHouse Cloud console.
API key secret – the secret shown once when the key is created.

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_at timestamp). 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.

The usage_cost table supports incremental sync on date. ClickHouse restates recent cost records until it locks them, so each incremental run re-pulls a trailing window and updates restated rows in place.

The activities table (the organization audit log) supports incremental sync on createdAt.

The remaining tables are full-refresh snapshots of your organization's current state.

Configuration

Option	Type	Required
`API key ID`	text	Yes
`API key secret`	password	Yes

Supported tables

Table	Description	Sync method	Incremental field	Primary key
`organizations`	The organization the API key is scoped to (the API returns exactly one).	Full refresh	—	—
`services`	All ClickHouse Cloud services in the organization, including state, tier, region, and scaling configuration.	Full refresh	—	—
`usage_cost`	Daily per-entity usage cost records in ClickHouse Credits (CHCs), broken down by storage, compute, backup, and data transfer.	Incremental, Full refresh	date	—
`api_keys`	All API keys in the organization (metadata only — the API never returns key secrets).	Full refresh	—	—
`members`	All members of the organization and their roles.	Full refresh	—	—
`activities`	The organization audit log: service, key, and member changes with actor details.	Incremental, Full refresh	createdAt	—
`backups`	Backups for every service in the organization (one API request per service).	Full refresh	—	—

Troubleshooting

If syncs fail with a permissions error, check the role on your API key in the ClickHouse Cloud console – usage cost and audit log data may require the Admin role.

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.