> For the complete documentation index, see [llms.txt](https://docs.ovaledge.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ovaledge.com/release8.1/connectors/connector-repositories/reporting-tool/domo.md).

# Domo

This article outlines the integration with Domo, enabling streamlined metadata management through crawling, report preview, and manual lineage building. The connector crawls Domo Pages, KPI Cards, and KPI Card Columns, providing metadata discovery and report-level visibility across Domo reporting assets.

This connector connects to Domo through REST APIs (v1 and v3) to retrieve reporting metadata and associated attributes. Authentication is established using a Domo API Client configured with the required OAuth scopes, along with a Domo user account to access content and metadata available within the configured Domo environment.

<div align="left"><img src="https://1121831267-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FFZv5WsZmBfXjiJfMU2zR%2Fuploads%2FGyh0PROSvVCvvGKfBjz3%2Funknown.png?alt=media&amp;token=cef500d0-8ffe-4ecf-9a6f-0f740c117724" alt="" height="292" width="624"></div>

## Overview

### Connector Details

<table data-header-hidden><thead><tr><th width="380"></th><th></th></tr></thead><tbody><tr><td>Connector Category</td><td>Reporting Tool</td></tr><tr><td>OvalEdge Release Supported</td><td>Release6.0.x and later</td></tr><tr><td><p>Connectivity</p><p>[How the connection is established with Domo]</p></td><td>REST APIs</td></tr><tr><td>Verified Domo REST API Version</td><td>v1 and v3</td></tr></tbody></table>

{% hint style="info" %}
The Domo connector has been validated with the mentioned "Verified Domo REST API versions". It is expected to be compatible with other supported Domo REST API versions. If there are any issues with validation or metadata crawling, please submit a support ticket for investigation and feedback.
{% endhint %}

### Connector Features

| Feature                                      | Availability |
| -------------------------------------------- | :----------: |
| Crawling                                     |       ✅      |
| Delta Crawling                               |       ❌      |
| Profiling                                    |      NA      |
| Query Sheet                                  |       ❌      |
| Report Preview                               |       ✅      |
| Auto Lineage                                 |      NA      |
| Manual Lineage                               |       ✅      |
| Secure Authentication via Credential Manager |       ✅      |
| Data Quality                                 |      NA      |
| DAM (Data Access Management)                 |      NA      |
| Bridge                                       |       ❌      |

{% hint style="info" %}
"NA" indicates that the respective feature is 'Not Applicable'.
{% endhint %}

### Metadata Mapping

The following objects are crawled from Domo and mapped to the corresponding UI assets.

<table data-search="false"><thead><tr><th width="159">Domo Object</th><th width="169">Domo Attribute</th><th width="176">OvalEdge Attribute</th><th width="175">OvalEdge Category</th><th width="160">OvalEdge Type</th></tr></thead><tbody><tr><td>Pages</td><td>name</td><td>Report Group</td><td>Report Group</td><td>Report Group</td></tr><tr><td>KPI Card</td><td>title</td><td>Report</td><td>Report</td><td>Report Name</td></tr><tr><td>KPI Card</td><td>type</td><td>Report Type</td><td>Report</td><td>KPI</td></tr><tr><td>KPI Card</td><td>description</td><td>Source Description</td><td>Report</td><td>Source Description</td></tr><tr><td>KPI Card Column</td><td>column/name</td><td>Column</td><td>Report Column</td><td>Report Column Name</td></tr><tr><td>KPI Card Column</td><td>mapping/dataType</td><td>Type</td><td>Report Column</td><td>Column Type</td></tr><tr><td>KPI Card Column</td><td>formula</td><td>Formula</td><td>Report Column</td><td>Formula</td></tr></tbody></table>

## Set up a Connection

### Prerequisites

The following are the prerequisites to establish a connection:

#### **Service Account User Permissions**

{% hint style="warning" %}
It is recommended to use a dedicated service account to establish the connection to the data source, configured with the following minimum set of permissions.
{% endhint %}

{% hint style="info" %}
**👨‍💻Who can provide these permissions?** These permissions are typically granted by the Domo administrator, as users may not have the required access to assign them independently.
{% endhint %}

<table><thead><tr><th width="179.9140625">Operations</th><th width="133.18359375">Objects</th><th width="431.28515625">Access Permissions</th></tr></thead><tbody><tr><td>Connector Validation</td><td>-</td><td>A Domo API client with the dashboard scope</td></tr><tr><td>Crawling</td><td>Pages</td><td>API client with the dashboard scope. The associated Domo user must have access to the pages being crawled.</td></tr><tr><td>Crawling</td><td>KPI Cards</td><td>Domo user account with access to the pages and their KPI cards.</td></tr><tr><td>Crawling</td><td>KPI Card Columns</td><td>The Domo user account must have access to each KPI card.</td></tr></tbody></table>

### Connection Configuration Steps

{% hint style="warning" %}
Users are required to have the Connector Creator role in order to configure a new connection.
{% endhint %}

1. Log into OvalEdge, go to **Administration** > **Connectors**, click **+ (New Connector)**, search for **Domo**, and complete the required parameters.

{% hint style="info" %}
Fields marked with an asterisk (\*) are mandatory for establishing a connection.
{% endhint %}

<table><thead><tr><th width="220">Field Name</th><th>Description</th></tr></thead><tbody><tr><td>Connector Type</td><td>By default, "<strong>Domo</strong>" is displayed as the selected connector type.</td></tr><tr><td>Credential Manager*</td><td><p>Select the desired credential manager from the drop-down list. Relevant parameters will be displayed based on the selection.</p><p>Supported Credential Managers:</p><ul><li>OE Credential Manager</li><li>AWS Secrets Manager</li><li>HashiCorp</li><li>Azure Key Vault</li></ul><p>For more details, click <a href="https://docs.ovaledge.com/release8.1/connectors/additional-requirements/credential-manager-configuration">here</a>.</p></td></tr><tr><td>Connector Name*</td><td><p>Enter a unique name for the Domoconnection              </p><p>(Example: "Domo_prod").</p></td></tr><tr><td>Connector Environment</td><td><p>Select the environment (Example: PROD, STG) configured for the connector.</p><p>For more details, click <a href="https://docs.ovaledge.com/release8.1/connectors/introduction-to-connectors/setup-and-connectivity/prerequisites#connector-environment">here</a>.</p></td></tr><tr><td>Connector Description</td><td>Enter a brief description of the connector.</td></tr><tr><td>Client id*</td><td>Enter the Client ID of the Domo API Client (OAuth application) configured in Domo. This identifier is used to authenticate API requests and obtain access tokens.</td></tr><tr><td>Client secret*</td><td>Enter the Client Secret associated with the Domo API Client. This value is used with the Client ID to authenticate and obtain an API access token.</td></tr><tr><td>Scopes*</td><td>Enter the OAuth scopes granted to the Domo API Client. These scopes are passed during access token generation and determine the APIs and resources accessible to the connector. Specify scopes as space-separated values and include the required permissions, such as dashboard for Page API access.</td></tr><tr><td>Base URL*</td><td>Enter the URL of the Domo instance to which the connector will connect (Example: https://xyz.domo.com).</td></tr><tr><td>Username*</td><td>Enter the username of a Domo account with access to the Pages and KPI Cards to be crawled. This account is used to establish an authenticated session for content-related API operations.</td></tr><tr><td>Password*</td><td>Enter the password associated with the specified Domo user account. This value is used to authenticate the user and establish a session for content API access.</td></tr><tr><td>Proxy Enabled*</td><td>Select Yes to route API calls through a proxy server. Select No to bypass the proxy and connect directly.</td></tr></tbody></table>

**Default Governance Roles**

<table data-header-hidden><thead><tr><th width="219"></th><th></th></tr></thead><tbody><tr><td>Default Governance Roles*</td><td>Select the appropriate users or teams for each governance role from the drop-down list. All users configured in the security settings are available for selection.</td></tr></tbody></table>

**Admin Roles**

<table data-header-hidden><thead><tr><th width="219"></th><th></th></tr></thead><tbody><tr><td>Admin Roles*</td><td>Select one or more users from the dropdown list for Integration Admin and Security &#x26; Governance Admin. All users configured in the security settings are available for selection.</td></tr></tbody></table>

**No of Archive Objects**

<table data-header-hidden><thead><tr><th width="221"></th><th></th></tr></thead><tbody><tr><td>No Of Archive Objects*</td><td><p>This shows the number of recent metadata changes to a dataset at the source. By default, it is off. To enable it, toggle the Archive button and specify the number of objects to archive.</p><p>Example: Setting it to 4 retrieves the last four changes, displayed in the 'Version' column of the 'Metadata Changes' module.</p></td></tr></tbody></table>

**Bridge**

<table data-header-hidden><thead><tr><th width="219"></th><th></th></tr></thead><tbody><tr><td>Select Bridge*</td><td><p>If applicable, select the bridge from the drop-down list.</p><p>The drop-down list displays all active bridges that have been configured. These bridges facilitate communication between data sources and the system without requiring changes to firewall rules.</p></td></tr></tbody></table>

2. After entering all connection details, the following actions can be performed:
   1. Click **Validate** to verify the connection.
   2. Click **Save** to store the connection for future use.
   3. Click **Save & Configure** to apply additional settings before saving.
3. The saved connection will appear on the **Connectors** home page.

## Manage Connector Operations

### Crawl

{% hint style="warning" %}
To perform crawl operations, users must be assigned the Integration Admin role.
{% endhint %}

The Crawl/Profile button allows users to select one or more report groups for crawling.&#x20;

1. Navigate to the **Connectors** page and click **Crawl/Profile.**
2. Select the report group to crawl.
3. The **Crawl** option is selected by default.
4. Click **Run** to collect metadata from the connected source and load it into the **Data Catalog**.
5. After a successful crawl, the information appears in the **Data Catalog** > **Report / Report Column** tab.

The **Schedule** checkbox allows automated crawling at defined intervals, from a minute to a year.

1. Click the **Schedule** checkbox to enable the **Select** Period drop-down.
2. Select a time period for the operation from the drop-down menu.
3. Click **Schedule** to initiate metadata collection from the connected source.
4. The system will automatically execute the **crawl** operation at the scheduled time.

#### Other Operations

The Connectors page provides a centralized view of all configured connectors, along with their health status.

**Managing connectors includes:**

* **Connector Health**: Displays the current status of each connector using a **green** icon for active connections and a **red** icon for inactive connections, helping to monitor connectivity with data sources.
* **Viewing**: Click the **Eye** icon next to the connector name to view connector details.

**Nine Dots Menu Options:**

To view, edit, validate, configure, or delete connectors, click on the **Nine Dots menu**.

* **Edit Connector**: Update and revalidate the data source.
* **Validate Connector**: Check the connection's integrity.
* **Settings**: Modify connector settings.
  * **Crawler**: Configure data extraction.
  * **Access Instructions**: Add notes on how data can be accessed.
  * **Business Glossary Settings**: Manage term associations at the connector level.
  * **Lineage**: Select the parsing method (Regular or AI-Augmented) for generating lineage, and set a confidence threshold to control when AI-generated lineage is accepted or held for review. For more details, click [here](https://docs.ovaledge.com/release8.1/connectors/introduction-to-connectors/setup-and-connectivity/connector-settings#lineage-applicable-for-supported-connectors).
  * **Others**: Configure notification recipients for metadata changes.
* **Delete Connector**: Remove a connector with confirmation.

For more details on connector settings, click [here](https://docs.ovaledge.com/release8.1/connectors/introduction-to-connectors/setup-and-connectivity/connector-settings).

## Limitations

<table><thead><tr><th width="61.95703125" align="right">S.No.</th><th width="657.38671875">Description</th></tr></thead><tbody><tr><td align="right">1</td><td>The connector supports crawling of top level Domo pages only. Sub pages are not supported.</td></tr><tr><td align="right">2</td><td>The connector processes a maximum of 50 pages returned by the Domo API.</td></tr><tr><td align="right">3</td><td>Document, Poll, Notebook, and Domo App KPI cards are excluded from crawling.</td></tr><tr><td align="right">4</td><td>KPI card columns include columns and Beast Mode formulas. Measures and dimensions are not distinguished separately.</td></tr></tbody></table>

## Troubleshooting

If incorrect parameters are entered, error messages may appear. Ensure all inputs are accurate to resolve these issues. If issues persist, contact the assigned support team.

<table><thead><tr><th width="61.1015625">S. No</th><th width="192">Error Message</th><th>Error Description &#x26; Resolution</th></tr></thead><tbody><tr><td>1</td><td><strong>Error while validating connection: Invalid Client ID or Client Secret</strong></td><td><p><strong>Error Description:</strong> Authentication failed because the configured Client ID or Client Secret is incorrect or does not match the Domo API Client.</p><p><strong>Resolution:</strong></p><ul><li>Verify that the Client ID and Client Secret are entered correctly.</li><li>Ensure the values belong to the intended Domo API Client.</li><li>Revalidate the connection after updating the credentials.</li></ul></td></tr><tr><td>2</td><td><strong>Error while validating connection: Invalid Base URL</strong></td><td><p><strong>Error Description:</strong> The specified Domo Base URL is invalid, unreachable, or does not correspond to the target Domo environment.</p><p><strong>Resolution:</strong></p><ul><li>Verify that the Base URL is entered correctly.</li><li>Ensure the URL points to the intended Domo instance.</li><li>Confirm that the URL is accessible from the connector environment.</li></ul></td></tr><tr><td>3</td><td><strong>Error while validating connection: Invalid Username or Password</strong></td><td><p><strong>Error Description:</strong> Authentication failed because the specified Domo user credentials are incorrect or the account cannot access the Domo environment.</p><p><strong>Resolution:</strong></p><ul><li>Verify that the Username and Password are entered correctly.</li><li>Ensure the user account is active and can sign in to the Domo instance.</li><li>Confirm that the user has access to the required Pages and KPI Cards.</li></ul></td></tr><tr><td>4</td><td><strong>Error while validating connection: Invalid OAuth Scopes</strong></td><td><p><strong>Error Description:</strong> The configured OAuth scopes are missing required permissions or contain invalid values, preventing access token generation or metadata retrieval.</p><p><strong>Resolution:</strong></p><ul><li>Verify that the required OAuth scopes are configured for the Domo API Client.</li><li>Ensure the scopes are entered as space-separated values.</li><li>Include the required permissions, such as dashboard for Page API access.</li></ul></td></tr></tbody></table>

***

Copyright © 2026, OvalEdge LLC, Peachtree Corners, GA, USA.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.ovaledge.com/release8.1/connectors/connector-repositories/reporting-tool/domo.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.