Redash

marmotdata/redash

Discover dashboards, charts, queries and data sources from Redash

Dashboards Assets Lineage Experimental

The Redash plugin discovers dashboards, charts, queries and data sources from a Redash instance.

It reads the REST API with a user API key, sent as Authorization: Key <api_key>. The key is found on the Redash user profile page.

Assets

Redash object	Marmot type	Name
Dashboard	Dashboard	dashboard name
Visualization widget	Chart	`<dashboard name>/<visualization name>`
Saved query	Data Model Object	query name
Data source	DataSource	data source name

Redash allows two dashboards or two queries to share a name. A repeat gets its Redash id appended, for example Revenue (2).

Lineage

Dashboard CONTAINS Chart, Data Model Object FEEDS Chart, and DataSource FEEDS Data Model Object.

Table references are read out of each query's SQL and linked as Table FEEDS Data Model Object. The table MRN is built with the provider and naming rule of the plugin that owns the queried system, so the edge lands on that plugin's asset rather than creating a second one. A data source type with no known Marmot identity produces no table edge.

Table lineage rides on the Data Model Object assets, so it needs include_queries.

Redash versions

The dashboard URL changed in Redash 10, so the plugin reads the version from /api/session and picks the matching form. A Redash that does not report its version is treated as current.

Archived dashboards are never returned by the Redash API, so include_archived only affects queries.

In the UI

Point-and-click, no config file needed.

1 Open Runs Create pipeline
2 Pick Redash from the plugin list.
3 Fill in the wizard, set a schedule, save.

Read the UI guide

With the CLI

Save a YAML config, then run marmot ingest.

ingest.yaml yaml

name: my-redash-pipeline
runs:
  - redash:
      host: "<host>"
      api_key: "***"

$ marmot ingest -c ingest.yaml

Read the CLI guide

Not using plugins? Other ways to populate Marmot

Terraform Declare assets as infrastructure-as-code. Pulumi Native TypeScript, Python, or Go resources. Kubernetes Operator Sync assets from Kubernetes custom resources.

Configuration

12 top-level fields. * marks required fields.

tags multiselect

Tags to apply to discovered assets

external_links object[]

External links to show on all assets

name string

Display name for the link

icon string

Icon identifier for the link

url string

URL to the external resource

filter object

Filter discovered assets by name (regex)

include multiselect

Include patterns for resource names (regex)

exclude multiselect

Exclude patterns for resource names (regex)

host string

Redash base URL, for example https://redash.example.com

api_key password

Redash user API key, found on the user profile page

verify_ssl bool

Whether to verify the server TLS certificate

default: true

include_queries bool

Whether to catalogue saved queries

default: true

include_data_sources bool

Whether to catalogue data sources

default: true

include_archived bool

Whether to include archived dashboards and queries

default: false

include_drafts bool

Whether to include unpublished dashboards and queries

default: true

discover_lineage bool

Whether to link dashboards, charts, queries and the tables they read

default: true

page_size int

Results to request per API page

default: 100

Assets emitted

Metadata this plugin attaches to each discovered asset.

Dashboard

RedashDashboardFields

13 fields

The metadata on a Dashboard asset.

id int

Redash dashboard id

slug string

URL slug

url string

Link to the dashboard in Redash

tags string[]

Tags set on the dashboard in Redash

is_draft bool

Whether the dashboard is unpublished

is_archived bool

Whether the dashboard is archived

owner string

Display name of the user who created the dashboard

created_at string

Creation timestamp

updated_at string

Last update timestamp

widget_count int

Number of widgets on the dashboard, text widgets included

query_count int

Number of distinct queries the dashboard reads

notes string

Text widget content, joined with blank lines. Redash dashboards have no description field

redash_version string

Redash release the dashboard was read from, which decides the URL shape

Chart

RedashChartFields

10 fields

The metadata on a Chart asset.

widget_id int

Redash widget id

visualization_id int

Redash visualization id

visualization_type string

Redash visualization type, for example CHART, TABLE or COUNTER

chart_type string

Normalised chart shape, read from options.globalSeriesType for a CHART

query_id int

Id of the query the chart renders

query_name string

Name of the query the chart renders

data_source string

Name of the data source the query runs against

dashboard string

Name of the dashboard the chart sits on

url string

Link to the visualization in Redash

is_hidden bool

Whether the widget is hidden on the dashboard

Query

RedashQueryFields

14 fields

The metadata on a Data Model Object asset, which is how a saved Redash query is catalogued.

id int

Redash query id

description string

Query description

data_source string

Name of the data source the query runs against

data_source_id int

Redash data source id

tags string[]

Tags set on the query in Redash

owner string

Display name of the user who created the query

schedule string

Refresh schedule: interval in seconds, time, day of week and until date

runtime float

Seconds the last run took

is_draft bool

Whether the query is unpublished

is_archived bool

Whether the query is archived

parameters string

Query parameters, each with a name, title and type

created_at string

Creation timestamp

updated_at string

Last update timestamp

url string

Link to the query in Redash

Data Source

RedashDataSourceFields

19 fields

The metadata on a DataSource asset. The connection options are copied through an allowlist, so a password is never recorded even when the API returns one.

id int

Redash data source id

type string

Redash data source type, for example pg, mysql or snowflake

syntax string

Query syntax the data source accepts, for example sql or json

view_only bool

Whether the data source is read only for the current user

paused bool

Whether query execution is paused

pause_reason string

Why the data source is paused

host string

Connection host

port int

Connection port

dbname string

Database name

database string

Database name, for sources that call it that

catalog string

Catalog name, for Trino, Presto and Databricks

schema string

Default schema

user string

Connection user

project string

Google Cloud project, for BigQuery

dataset string

Dataset name

account string

Account identifier, for Snowflake

warehouse string

Warehouse name, for Snowflake

region string

Cloud region

url string

Connection URL, for sources configured with one