Metabase

Availability:

Airbyte Cloud Airbyte OSS PyAirbyte

Support Level:

community

Connector Version:

2.0.4(Last updated 2 days ago)

CDK Version:

0.67.3

Sync Success Rate:

Usage Rate:

This page contains the setup guide and reference information for the Metabase source connector.

Prerequisites

To set up Metabase you need:

• username and password - Credential pairs to authenticate with Metabase instance. This may be used to generate a new session_token if necessary. An email from Metabase may be sent to the owner's account every time this is being used to open a new session.
• session_token - Credential token to authenticate requests sent to Metabase API. Usually expires after 14 days.
• instance_api_url - URL to interact with Metabase instance API, that uses https.

Setup guide

You can find or create authentication tokens from Metabase by running the following command:`

curl -X POST \
-H "Content-Type: application/json" \
-d '{"username": "person@metabase.com", "password": "fakepassword"}' \
http://localhost:3000/api/session

If you’re working with a remote server, you’ll need to replace localhost:3000 with your server address. This request will return a JSON object with a key called id and the token as the key’s value, e.g.:

{"id":"38f4939c-ad7f-4cbe-ae54-30946daf8593"}

You can use this id value as your session_token when configuring the connector. Note that these credentials tokens may expire after 14 days by default, and you might need to update your connector configuration with a new value when that happens (The connector should throw exceptions about Invalid and expired session tokens and return a 401 (Unauthorized) status code in that scenario).

If you are hosting your own Metabase instance, you can configure this session duration on your Metabase server by setting the environment variable MAX_SESSION_AGE (value is in minutes).

If the connector is supplied with only username and password, a session_token will be generated every time an authenticated query is running, which might trigger security alerts on the user's Metabase account.

Supported sync modes

The Metabase source connector supports the following sync modes:

• Full Refresh - Overwrite

Supported Streams

• Card
• Collections
• Dashboard
• User
• Databases
• Native Query Snippet

Tutorials

Data type mapping

Integration Type	Airbyte Type	Notes
string	string
integer, number	number
array	array
object	object

Features

Feature	Supported?(Yes/No)	Notes
Full Refresh Sync	Yes
Incremental Sync	No
SSL connection	Yes
Namespaces	No

Reference

Config fields reference

Field

Type

Property name

string

instance_api_url

username

string

username

password

string

password

string

session_token

Changelog

Expand to review

Version	Date	Pull Request	Subject
2.0.4	2024-07-06	40940	Update dependencies
2.0.3	2024-06-26	40528	Update dependencies
2.0.2	2024-06-22	40117	Update dependencies
2.0.1	2024-06-06	39205	[autopull] Upgrade base image to v1.2.2
2.0.0	2024-03-01	35680	Updates dashboards stream, Base image migration: remove Dockerfile and use the python-connector-base image, migrated to poetry
1.1.0	2023-10-31	31909	Add databases and native_query_snippets streams
1.0.1	2023-07-20	28470	Update CDK to 0.47.0
1.0.0	2023-06-27	27777	Remove Activity Stream
0.3.1	2022-12-15	20535	Run on CDK 0.15.0
0.3.0	2022-12-13	19236	Migrate to YAML.
0.2.0	2022-10-28	18607	Disallow using http URLs
0.1.0	2022-06-15	6975	Initial (alpha) release