> ## Documentation Index
> Fetch the complete documentation index at: https://support.configview.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Fivetran setup

Configview reads your Fivetran account (the ELT service that copies data from your business systems into a warehouse) through the **Fivetran REST API** (`https://api.fivetran.com/v1`), using an **API key and secret** from the Fivetran dashboard. Configview sends only `GET` requests. It never creates, changes, pauses or deletes anything in Fivetran.

You will end up with **2 required secrets** (`FIVETRAN_API_KEY` and `FIVETRAN_API_SECRET`) in Configview when setup is complete.

> **Scope of this integration today.** Configview answers "who can build and run pipelines, which systems feed the warehouse, and which pipelines are broken, stale or owned by someone who left": users and service accounts with their roles, teams and memberships, groups and who can reach them, every connection (source type, schema name, paused or running, setup and sync state, schedule, last success and failure, creator), destinations, webhooks by host, and API key metadata. It does **not** read connection configuration, credentials, synced data, sync logs, schemas or transformation code. Fivetran does not expose usage (monthly active rows) or an audit log through its pull API, so those are not collected.

***

## What you need

* A Fivetran account and an administrator who can generate API keys
* A **system key**, or a service account, with a read-only role such as **Account Reviewer**

***

## Step 1: Open the Fivetran page in Configview

Open Configview in a second browser tab and leave it open:

`https://{companyname}.configview.com/admin/integrations/fivetran`

***

## Step 2: Create the API key

1. In Fivetran open **Account Settings > System Keys** (or your profile menu > **API Key**) and generate a key
2. Prefer a system key with the **Account Reviewer** role. Configview needs to list users, teams, roles, groups, connections, destinations and webhooks, and nothing else. A personal key inherits your own permissions, which are usually broader than needed.
3. Copy the **API key** and the **API secret** (shown once)
4. In the Configview tab paste them into `FIVETRAN_API_KEY` and `FIVETRAN_API_SECRET` under **Credentials** and save

***

## Step 3: Connect and verify

1. Click **Connect**. Configview creates its tables and schedules every collector at your default run time:

| Script | Notes |
| - | - |
| **Users** | Every user and service account: email, name, role, active, last login. |
| **Teams / Team memberships** | Teams, their role and who is in them. |
| **Roles** | Standard and custom roles and the resources they manage. |
| **Groups / Group users** | Destination groups and which users can reach each one. |
| **Connections** | Every pipeline: source type, schema name, state, schedule, last success and failure, creator. |
| **Destinations** | Warehouse type, region, setup status and how it is reached. |
| **Webhooks** | Destination host and event names. |
| **API keys** | Key metadata. Private Preview: skipped unless Fivetran has enabled it. |

2. Click **Verify now**. The health check reads both secrets, then calls account info and one page of groups.

If a check fails:

* **401.** The key or secret is wrong or revoked.
* **403.** The key's role cannot read that area.

***

## Data Tables

Each table has a `run_at` column and keeps only the newest run.

| Table | Source | Key Columns |
| - | - | - |
| `fivetran_users` | `GET /v1/users` | user\_id, email, role, active, user\_type, has\_api\_key, logged\_in\_at, created\_at |
| `fivetran_teams` | `GET /v1/teams` | team\_id, name, description, role |
| `fivetran_team_memberships` | `GET /v1/teams/{teamId}/users` | team\_id, user\_id, role, created\_at |
| `fivetran_roles` | `GET /v1/roles` | name, scope\_list, is\_custom, is\_deprecated |
| `fivetran_groups` | `GET /v1/groups` | group\_id, name, created\_at |
| `fivetran_group_users` | `GET /v1/groups/{groupId}/users` | group\_id, user\_id, email, role, active, logged\_in\_at |
| `fivetran_connections` | `GET /v1/connections` | connection\_id, service, schema\_name, group\_id, paused, setup\_state, sync\_state, succeeded\_at, failed\_at, created\_by |
| `fivetran_destinations` | `GET /v1/destinations` | destination\_id, service, region, group\_id, setup\_status, networking\_method |
| `fivetran_webhooks` | `GET /v1/webhooks` | webhook\_id, webhook\_type, url\_host, events, active, created\_by |
| `fivetran_api_keys` | `GET /v1/users/api-keys` | user\_id, key\_last4, key\_status, expires\_at, last\_rotated\_at |

***

## Things worth knowing

**Connection configuration is never read.** The connections list returns each connection's setup `config` (hosts, usernames and sometimes passwords) and a short-lived setup token. Configview reads named fields only. Task, warning and setup-test text is reduced to counts.

**Who owns a pipeline.** `created_by` joins to `fivetran_users.user_id`. A running connection whose creator is suspended or no longer in the account is listed as orphaned.

**Service accounts.** API-only accounts can have no email. `user_type` and `has_api_key` are Private Preview fields in Fivetran and stay empty until Fivetran support enables them for your account.

**API keys.** Only the last four characters of a key are kept, with its status and expiry. The key list is Private Preview; if it is not enabled for you, that collector skips.

**Rate limit.** Fivetran allows 20,000 REST requests per hour on paid plans (500 on a trial), and answers HTTP 429 with `Retry-After`. Configview paces itself at 120 requests a minute and waits as long as Fivetran asks. Group and team memberships need one request per group and per team.

## Known gaps

* No usage or monthly active rows, and no audit log, through the pull API
* System keys, private links, proxy agents and transformations are not collected yet
* Organisations using Fivetran Platform Connector tables in the warehouse have richer logs there; Configview does not read them

## What isn't collected

* Connection configuration, credentials, setup tokens and external secrets manager keys
* Webhook URLs beyond the host, and signing secrets
* API key values (only the last four characters)
* User phone numbers and avatars
* Synced data, sync logs, schemas, and transformation code


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.