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

# Mode Connector

> Connect Mode Analytics dashboards to Collate with our comprehensive connector guide. Easy setup, configuration steps, and metadata extraction instructions.

export const ConnectorDetailsHeader = ({name, icon, stage, availableFeatures, unavailableFeatures = [], availableFeaturesCollate = []}) => {
  const showSubHeading = availableFeatures?.length > 0 || unavailableFeatures?.length > 0 || availableFeaturesCollate?.length > 0;
  const totalAvailableFeatures = [...availableFeatures || [], ...availableFeaturesCollate || []];
  return <div className="container">
      <div className="Heading">
        <div className="flex items-center gap-3">
          {icon && <div className="IconContainer">
              <img src={icon} alt={name} noZoom className="ConnectorIcon" />
            </div>}
          <h1 className="ConnectorName">{name}</h1>
          <span className={`StageBadge ${stage === 'PROD' ? 'prod' : 'beta'}`}>
            {stage}
          </span>
        </div>
      </div>
      {showSubHeading && <div className="SubHeading">
          <div className="FeaturesHeading">Feature List</div>
          <div className="FeaturesList">
            {totalAvailableFeatures.map(feature => <div className="FeatureTag AvailableFeature" key={feature}>
                ✓ {feature}
              </div>)}
            {unavailableFeatures.map(feature => <div className="FeatureTag UnavailableFeature" key={feature}>
                ✕ {feature}
              </div>)}
          </div>
        </div>}
    </div>;
};

<ConnectorDetailsHeader icon="/public/images/connectors/mode.webp" name="Mode" stage="PROD" availableFeatures={["Dashboards", "Charts", "Lineage"]} unavailableFeatures={["Owners", "Tags", "Datamodels", "Projects"]} />

This section provides guides and references to use the Mode connector.
Configure and schedule Mode metadata and profiler workflows from the Collate UI:

* [Requirements](#requirements)
* [Metadata Ingestion](#metadata-ingestion)
* [Lineage](#lineage)
* [Troubleshooting](/ai-2-0/connectors/dashboard/mode/troubleshooting)

## Requirements

Collate relies on Mode's API, which is exclusive to members of the Mode Business Workspace. This means that only resources that belong to a Mode Business Workspace can be accessed via the API.

## Metadata Ingestion

To ingest metadata from Mode, you need to create a service connection. The service connects Mode with Collate. Once you create a service, Collate automatically starts ingesting metadata.

### Step 1: Add New Service

1. In the left navigation, click **Connections**.
2. On the **Connections** page, click **Add New Service**.

<img src="https://mintcdn.com/collatedocs/bv5oe4uRjuorTJO1/public/images/ai-2.0/connectors/metadata-ingestion/add-new-service.png?fit=max&auto=format&n=bv5oe4uRjuorTJO1&q=85&s=733cef1141ef13d318634aa9f407eb2b" alt="Add New Service" width="2992" height="1256" data-path="public/images/ai-2.0/connectors/metadata-ingestion/add-new-service.png" />

### Step 2: Select a Service and Connector

From the service type dropdown, select **Dashboard Services**, then click the **Mode** connector tile.

<img src="https://mintcdn.com/collatedocs/VsJxWKWlvReeFtlo/public/images/ai-2.0/connectors/metadata-ingestion/Dashboard/select-service/mode.png?fit=max&auto=format&n=VsJxWKWlvReeFtlo&q=85&s=b20441b2f99828b6577d6d33745638be" alt="Select Service" width="1972" height="1470" data-path="public/images/ai-2.0/connectors/metadata-ingestion/Dashboard/select-service/mode.png" />

### Step 3: Add Service Name and Description

* Enter a unique, descriptive **Service Name**. Collate identifies services by their service name. Enter a name that distinguishes this deployment from other Mode services you are ingesting metadata from.
* Optional: Enter a **Description** for the service.

<img src="https://mintcdn.com/collatedocs/kTp2dTyiNAX4Np5A/public/images/ai-2.0/connectors/metadata-ingestion/Dashboard/service-name/mode.png?fit=max&auto=format&n=kTp2dTyiNAX4Np5A&q=85&s=57d72f9e58fa3ae6fc5ddb2091bfa3ab" alt="Add New Service Name" width="1496" height="858" data-path="public/images/ai-2.0/connectors/metadata-ingestion/Dashboard/service-name/mode.png" />

<Note>
  **Note**: The service name cannot be changed after it is set.
</Note>

### Step 4: Configure Connection Options

Specify where ingestion runs, provide your source credentials, and verify the connection.

#### Select Ingestion Runner

Select an **Ingestion Runner**: the runner where the ingestion pipeline will execute.

<img src="https://mintcdn.com/collatedocs/bv5oe4uRjuorTJO1/public/images/ai-2.0/connectors/metadata-ingestion/select-ingestion-runner.png?fit=max&auto=format&n=bv5oe4uRjuorTJO1&q=85&s=1249f828648614445e8a976ea1933487" alt="Add Name and Select Ingestion Runner" width="1444" height="506" data-path="public/images/ai-2.0/connectors/metadata-ingestion/select-ingestion-runner.png" />

#### Enter Connection Details

Enter the connection details for Mode. The right-hand panel in the UI displays inline help for each field.

<img src="https://mintcdn.com/collatedocs/VsJxWKWlvReeFtlo/public/images/ai-2.0/connectors/metadata-ingestion/Dashboard/connection-details/mode.png?fit=max&auto=format&n=VsJxWKWlvReeFtlo&q=85&s=1215cd118b9a515ee9c386578d30e3ff" alt="Configure Service Connection" width="1450" height="1026" data-path="public/images/ai-2.0/connectors/metadata-ingestion/Dashboard/connection-details/mode.png" />

* **hostPort**: Host and port for the Mode dashboard. The hostPort parameter specifies the host and port of the Mode server. This should be specified as a string in the format `https://app.mode.com`.
* **accessToken**: Access Token for Mode Dashboard. Get the Access Token by following the steps below:

  * Navigate to your Mode homepage.
  * Click on your name in the upper left corner and click My Account.
  * Click on API Tokens on the left side.
  * To generate a new API token and password, enter a token name and click **Create Token**.
  * Copy the generated access token and password.

  For detailed information, see the [Mode API reference](https://mode.com/developer/api-reference/introduction/).
* **accessTokenPassword**: Access Token Password for Mode Dashboard. Copy the access token password from the step above where a new token is generated. For detailed information, see the [Mode API reference](https://mode.com/developer/api-reference/introduction/).
* **workspaceName**: Mode Workspace Name. Name of the Mode workspace from which Collate fetches metadata.

#### Test Connection

Once the credentials have been added, click on **Test Connection** and **Save** the changes.

<img src="https://mintcdn.com/collatedocs/bv5oe4uRjuorTJO1/public/images/ai-2.0/connectors/metadata-ingestion/test-connection.png?fit=max&auto=format&n=bv5oe4uRjuorTJO1&q=85&s=3365cff7bb9d82c85a2ff9ab559d6f11" alt="Test Connection" width="1446" height="188" data-path="public/images/ai-2.0/connectors/metadata-ingestion/test-connection.png" />

### Step 5: Configure Ingestion Options

In the **What to Ingest** step, use filter patterns to control which assets Collate ingests from your dashboard service. Filter patterns use regular expressions applied to asset names.

#### How Filter Patterns Work

* **Include**: Add one or more comma-separated regular expressions. Collate ingests only assets whose names match at least one expression. Leave blank to include all assets.
* **Exclude**: Add one or more comma-separated regular expressions. Collate skips any asset whose name matches an expression. Leave blank to exclude nothing.

Rules match asset names using one of five expressions:

* **contains**: matches any name containing the value. For example, `sales` matches `my_sales_data` and `sales_2024`.
* **starts with**: matches names beginning with the value. For example, `prod_` matches `prod_db` and `prod_schema`.
* **ends with**: matches names ending with the value. For example, `_raw` matches `events_raw` and `logs_raw`.
* **is exactly**: matches the exact name only. For example, `analytics` matches only `analytics`.
* **matches regex**: matches names using a regular expression. For example, `^prod_.*_v\d+$` matches `prod_events_v1`.

When both Include and Exclude are set, Exclude takes priority.

<Tip>
  **Tip**: Leave all filter patterns empty to ingest all dashboards, charts, and data models available in the source.
</Tip>

**Filter Options**

The Dashboard, Chart, and Data Model sections each include the following filter options:

* **Dashboard**: Controls which dashboards Collate ingests from the source.
* **Chart**: Controls which charts within the ingested dashboards are included.
* **Data Model**: Controls which data models are included in metadata ingestion.

Each section provides the following controls:

* **Scan Mode**: Choose between the following scan modes:
  * **Scan all**: Ingests every asset of that type the connector can access. This is the default.
  * **Only specific**: Enables include rules so only assets matching at least one rule are ingested.
* **Exclude system toggle**: Use this toggle to automatically filter out system-reserved names defined by the connector—for example, **Exclude system databases** for the Databases section.
* **Always exclude**: Add permanent exclusion rules (shown in red). Assets matching these rules are never ingested, regardless of include rules.
* **Preview**: Shows a real-time summary of what will be in scope based on your current rules.
* **Include rules** *(available only in **Only specific** mode)*: Click **+ Add** to define a rule. Added rules appear as chips. An asset is included if it matches any rule.

<Tip>
  **Tip**: If [AutoPilot](/ai-2-0/admin-guide/applications/autopilot) is enabled, usage tracking, data lineage, and other downstream workflows start automatically after the first metadata ingestion completes.
</Tip>

### Step 6: Create & Deploy

Click **Create & Deploy** to deploy the agent and start the first metadata ingestion run. Collate saves the service configuration and immediately begins pulling metadata from the source.

To monitor ingestion progress or view the service you just added, go to **Connections** in the left navigation and select your service.

## Configure Metadata Agent and Schedule Ingestion

The **Metadata Agent** extracts dashboards, charts, data models, and other structural metadata from your source and keeps your Collate catalog in sync. It powers discovery, lineage, and governance across your data assets.

When you click **Create & Deploy**, Collate automatically deploys a Metadata Agent for this service and triggers the first ingestion run. View its status and run history from the **Agents** tab on the service detail page.

To configure the additional Metadata Agent and schedule ingestion, follow these steps:

1. In the left navigation, click **Connections** and select your service.

2. Click the **Agents** tab.

3. Click **Add Agent** and select **Metadata** from the dropdown.
   <img src="https://mintcdn.com/collatedocs/bv5oe4uRjuorTJO1/public/images/ai-2.0/connectors/metadata-ingestion/add-metadata-agent.png?fit=max&auto=format&n=bv5oe4uRjuorTJO1&q=85&s=accad7d1c4ddf209781bff851d51d464" alt="Add Metadata Agent" width="2398" height="1144" data-path="public/images/ai-2.0/connectors/metadata-ingestion/add-metadata-agent.png" />
   For some services, the dropdown is not available and clicking **Add Agent** takes you directly to the agent configuration page.

4. On the **Configure Ingestion** page, do the following and click **Next**.

   * **Name this Ingestion**: Enter a unique recognizable name for this ingestion pipeline.

     <img src="https://mintcdn.com/collatedocs/bv5oe4uRjuorTJO1/public/images/ai-2.0/connectors/metadata-ingestion/metadata-agent-name.png?fit=max&auto=format&n=bv5oe4uRjuorTJO1&q=85&s=d5ec1f0f3742cadab8cd54c602c97239" alt="Name this Ingestion" width="1578" height="644" data-path="public/images/ai-2.0/connectors/metadata-ingestion/metadata-agent-name.png" />

   * **Agent Setup**: Configure ingestion parameters. The following fields are available:

     | Field                    | Default | Description                                                                                                                                                                                                                                                                                                                                            |
     | ------------------------ | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
     | Db Service Prefixes      | —       | List of database service name prefixes used to resolve lineage between dashboards and database assets. Accepted formats: `DBService`, `DBService.Database`, `DBService.Database.Schema`, `DBService.Database.Schema.Table`.                                                                                                                            |
     | Query Parser Type        | Auto    | Select the SQL parser used for lineage extraction from dashboard queries. **Auto** selects the best available parser automatically. **SqlGlot** is a high-performance parser with excellent dialect support; falls back to SqlParse on failure. **SqlFluff** is a comprehensive parser with strong dialect support; falls back to SqlParse on failure. |
     | Mark Deleted Dashboards  | On      | Soft-delete dashboards in Collate when they are removed from the source. Associated lineage is also deleted.                                                                                                                                                                                                                                           |
     | Mark Deleted Data Models | On      | Soft-delete data models in Collate when they are removed from the source. Associated lineage is also deleted.                                                                                                                                                                                                                                          |
     | Mark Deleted Charts      | On      | Soft-delete charts in Collate when they are removed from the source.                                                                                                                                                                                                                                                                                   |
     | Include Data Models      | On      | Ingest data model metadata.                                                                                                                                                                                                                                                                                                                            |
     | Include Draft Dashboards | On      | Ingest dashboards that are in draft state.                                                                                                                                                                                                                                                                                                             |
     | Include Usage            | On      | Collect and ingest usage statistics for dashboards.                                                                                                                                                                                                                                                                                                    |

     <img src="https://mintcdn.com/collatedocs/VsJxWKWlvReeFtlo/public/images/ai-2.0/connectors/metadata-ingestion/Dashboard/dashboard-agent-setup.png?fit=max&auto=format&n=VsJxWKWlvReeFtlo&q=85&s=4331bedb92cf4fc886548ed7e9d9caf7" alt="Agent Setup" width="1570" height="1434" data-path="public/images/ai-2.0/connectors/metadata-ingestion/Dashboard/dashboard-agent-setup.png" />

   * **Filter Patterns**: Apply include or exclude rules to scope which dashboards, charts, data models, and projects this agent ingests. These follow the same filter options described in **Step 5**.

     <img src="https://mintcdn.com/collatedocs/VsJxWKWlvReeFtlo/public/images/ai-2.0/connectors/metadata-ingestion/Dashboard/dashboard-filter-pattern.png?fit=max&auto=format&n=VsJxWKWlvReeFtlo&q=85&s=fafba3522eb159607f520f8252cace56" alt="Filter Patterns" width="1546" height="844" data-path="public/images/ai-2.0/connectors/metadata-ingestion/Dashboard/dashboard-filter-pattern.png" />

   * **Scope & Behaviour**: Control what metadata to include and how to handle deletions. Toggle each option on or off based on your needs:

     | Toggle                 | Default | Description                                                                                                                                                                                           |
     | ---------------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
     | Enable Debug Log       | Off     | Sets the ingestion log level to DEBUG. Useful for troubleshooting.                                                                                                                                    |
     | Include Current Owners | Off     | When enabled, replaces the current owner with a new owner from the source if the current owner is null. Recommended to keep enabled during the first metadata ingestion to capture owner information. |
     | Include Tags           | On      | Ingest tags from the source.                                                                                                                                                                          |
     | Override Metadata      | Off     | When on, source values overwrite existing descriptions, tags, owners, and display names in Collate. When off, Collate only updates fields that have no existing value.                                |
     | Override Lineage       | Off     | When on, existing lineage is replaced with newly extracted lineage on each run.                                                                                                                       |

     <img src="https://mintcdn.com/collatedocs/VsJxWKWlvReeFtlo/public/images/ai-2.0/connectors/metadata-ingestion/Dashboard/dashboard-scope-bahaviour.png?fit=max&auto=format&n=VsJxWKWlvReeFtlo&q=85&s=b62494bc009ab02b79062e74519e89de" alt="Scope & Behaviour" width="1552" height="1014" data-path="public/images/ai-2.0/connectors/metadata-ingestion/Dashboard/dashboard-scope-bahaviour.png" />

5. On the **Schedule Interval** page, set when the agent runs:

   * **Schedule**: Choose a preset interval (Hourly, Daily, Weekly, Monthly) or enter a custom cron expression.
   * **On-Demand**: No automatic schedule; trigger the agent manually when needed.

   <img src="https://mintcdn.com/collatedocs/bv5oe4uRjuorTJO1/public/images/ai-2.0/connectors/metadata-ingestion/schedule.png?fit=max&auto=format&n=bv5oe4uRjuorTJO1&q=85&s=25cc1d78f6f2a8bd115830d034d1d8d1" alt="Schedule Interval" width="1588" height="1044" data-path="public/images/ai-2.0/connectors/metadata-ingestion/schedule.png" />

6. Click **Add** to deploy the agent.

## Lineage

Lineage in Collate shows you which database tables power each dashboard. When lineage is set up, you can trace any dashboard back to the exact source tables in your database.

There is no separate lineage agent or lineage pipeline — lineage is collected as part of the same metadata ingestion workflow. To enable lineage, open the **Configure Metadata Agent** section above, scroll to the **Lineage Information** section in the agent setup, and enter one or more database service names in the **Db Service Prefixes** field.

<img src="https://mintcdn.com/collatedocs/VsJxWKWlvReeFtlo/public/images/ai-2.0/connectors/metadata-ingestion/Dashboard/dashboard-lineage.png?fit=max&auto=format&n=VsJxWKWlvReeFtlo&q=85&s=f5bd7e6138bba796d865fc4ad94697ae" alt="Lineage Information" width="2060" height="1284" data-path="public/images/ai-2.0/connectors/metadata-ingestion/Dashboard/dashboard-lineage.png" />

Configuring **Db Service Prefixes** is optional but recommended — it restricts table matching to specific database services. If left blank, Collate attempts to match source tables across all ingested database services.

| What you enter                  | What it matches                                           |
| ------------------------------- | --------------------------------------------------------- |
| `SnowflakeProd`                 | All tables in the Snowflake service named `SnowflakeProd` |
| `SnowflakeProd.sales_db`        | Tables in the `sales_db` database within `SnowflakeProd`  |
| `SnowflakeProd.sales_db.public` | Tables in the `public` schema within `sales_db`           |

<Tip>
  **Tip**: If your dashboards pull data from multiple database services, add each service as a separate entry in the **Db Service Prefixes** field.
</Tip>

## Troubleshooting

<Columns cols={2}>
  <Card title="Mode Troubleshooting" href="/ai-2-0/connectors/dashboard/mode/troubleshooting">
    Learn more about how to troubleshoot common Mode connector issues and resolve configuration or ingestion errors.
  </Card>
</Columns>