Skip to main content

Redash

Integrate Redash with the Catalog to sync dashboards and queries.

Requirements​

  • You must have an Admin User API key.

Catalog Managed​

1. Get Credentials​

To get things started with Redash in the Catalog, you will need to be a Redash admin and provide us with:

  • Your User API key
  • Your Base URL

To retrieve your User API key go to "Settings > Account", select the API Key tab and copy the value from there.

As for your Base URL, we need the full domain of your Redash account. The expected format for it is https://app.redash.io/myorg/ or https://redash.myorg.com/

For more information, see the Redash API documentation.

2. Add Credentials in Catalog App​

You can now enter the newly created credentials in the Catalog App integrations settings.

  • Go to "Settings > Integrations"
  • Click on "Redash Add"
  • Select "Managed by Catalog"
  • Choose a name for this integration in Catalog
  • Add the credentials as JSON
  • Click on "Save"

The expected JSON format is:

{
    "baseUrl": "<str>",
    "apiKey": "<str>"
}