This guide will walk you through how to set up Synq integration with Looker. We connect to Looker via API (to fetch the structure of your Looker objects) and via git (to fetch lookML) models. As a result, we can create a complete picture of your Looker setup and connect it to your data warehouse and dbt models.
To finish this guide, you’ll need the following:
→ Admin permissions for Looker
→ Access to GitHub or GitLab
→ Admin Access to your Looker repository (only repo admins can add deploy keys)
⏱️ Estimated time to finish: 15 minutes.
The optimal way to setup is an API key with admin role permissions, which would give Synq the necessary permissions to fetch all observability data to reconstruct end-to-end lineage of your Looker objects.
In case you are limited by security policies to provide Admin-level access, we also offer an admin-less integration using a CLI tool. Reach out to us in our shared Slack channel to set this up.
Follow the Looker access and LookML access guides below to set up the Looker integration.
To process your Looker data, we need access to your Looker instance. Synq connects to Looker with
clientSecret, which is bound to a user with Admin permissions.
- Go to
Admin > Usersand create a new user with
synq@<your-domain>.comas email address
Send setup emailsand Save
- Give the user the
- Edit the
synq@<your-domain>.comuser and create
clientSecretAPI permissions (see Looker integration docs for details).
New API Key
- In Synq, you’ll need your instance base URL (
clientSecretsecurely to complete the integration.
To process LookML models, we need access to the underlying Looker repository. The Git integration has to be setup as a separate step and can be done in Synq: https://app.synq.io/settings/integrations/git. The process executes in two phases:
1. Collect information about your repo
- Repository URL—The full URL of the git repository that contains your Looker project (we support both HTTPS and SSH URLs).
- Branches to analyze (default:
main)—Synq, by default, analyses
mainbranches. Please provide the name if you prefer us to process the code from any other branch. We support multiple branches too.
- Path to analyze (default:
.)—Synq, by default, looks for your LookML source code in the root of the repository. If you store your code in a subdirectory, please provide us with a path if your Looker project uses a subdirectory. In most cases, it is best to leave this to use default to analyze everything in the repository.
2. Setup Deployment Key
To finish the setup, you will have to store the public part of the Synq deployment key with your git provider. You can follow the instructions based on your git provider below: