2024-06-18 15:53:06 +02:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
								---
							 
						 
					
						
							
								
									
										
										
										
											2025-06-20 19:46:38 +05:30 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								title: Mode Connector | OpenMetadata Dashboard Integration Guide
							 
						 
					
						
							
								
									
										
										
										
											2024-06-18 15:53:06 +02:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
								slug: /connectors/dashboard/mode
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								---
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								{% connectorDetailsHeader
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								  name="Mode"
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								  stage="PROD"
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								  platform="OpenMetadata"
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								  availableFeatures=["Dashboards", "Charts", "Lineage"]
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								  unavailableFeatures=["Owners", "Tags", "Datamodels", "Projects"]
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								/ %}
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								In this section, we provide guides and references to use the Mode connector.
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								Configure and schedule Mode metadata and profiler workflows from the OpenMetadata UI:
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								-  [Requirements ](#requirements ) 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								-  [Metadata Ingestion ](#metadata-ingestion ) 
						 
					
						
							
								
									
										
										
										
											2025-03-17 11:45:55 +05:30 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								-  [Lineage ](#lineage ) 
						 
					
						
							
								
									
										
										
										
											2025-04-01 10:11:51 +05:30 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								-  [Troubleshooting ](/connectors/dashboard/mode/troubleshooting ) 
						 
					
						
							
								
									
										
										
										
											2024-06-18 15:53:06 +02:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
									
										
										
										
											2025-04-18 08:42:17 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								{% partial file="/v1.8/connectors/ingestion-modes-tiles.md" variables={yamlPath: "/connectors/dashboard/mode/yaml"} /%}
							 
						 
					
						
							
								
									
										
										
										
											2024-06-18 15:53:06 +02:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								## Requirements
  
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								OpenMetadata 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
  
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								{% partial 
							 
						 
					
						
							
								
									
										
										
										
											2025-04-18 08:42:17 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								  file="/v1.8/connectors/metadata-ingestion-ui.md" 
							 
						 
					
						
							
								
									
										
										
										
											2024-06-18 15:53:06 +02:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
								  variables={
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								    connector: "Mode", 
							 
						 
					
						
							
								
									
										
										
										
											2025-04-18 08:42:17 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								    selectServicePath: "/images/v1.8/connectors/mode/select-service.png",
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								    addNewServicePath: "/images/v1.8/connectors/mode/add-new-service.png",
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								    serviceConnectionPath: "/images/v1.8/connectors/mode/service-connection.png",
							 
						 
					
						
							
								
									
										
										
										
											2024-06-18 15:53:06 +02:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
								} 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								/%}
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								{% stepsContainer %}
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								{% extraContent parentTagName="stepsContainer" %}
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								#### Connection Details
  
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								**hostPort**: Host and Port 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 below steps:
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								-  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 visit [here ](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 visit [here ](https://mode.com/developer/api-reference/introduction/ ).
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								**workspaceName**: Mode Workspace Name.
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								Name of the mode workspace from where the metadata is to be fetched.
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								{% /extraContent %}
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
									
										
										
										
											2025-04-18 08:42:17 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								{% partial file="/v1.8/connectors/test-connection.md" /%}
							 
						 
					
						
							
								
									
										
										
										
											2024-06-18 15:53:06 +02:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
									
										
										
										
											2025-04-18 08:42:17 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								{% partial file="/v1.8/connectors/dashboard/configure-ingestion.md" /%}
							 
						 
					
						
							
								
									
										
										
										
											2024-06-18 15:53:06 +02:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
									
										
										
										
											2025-04-18 08:42:17 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								{% partial file="/v1.8/connectors/ingestion-schedule-and-deploy.md" /%}
							 
						 
					
						
							
								
									
										
										
										
											2024-06-18 15:53:06 +02:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								{% /stepsContainer %}
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
									
										
										
										
											2025-04-18 08:42:17 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								{% partial file="/v1.8/connectors/dashboard/dashboard-lineage.md" /%}