Skip to content

Commit a38b0fc

Browse files
docs: add Lightdash BI integration documentation (#2176)
Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
1 parent 9168cbe commit a38b0fc

3 files changed

Lines changed: 42 additions & 0 deletions

File tree

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
title: "Lightdash"
3+
---
4+
5+
After you connect Lightdash, Elementary will automatically and continuously extend the column-level-lineage to the dashboard and chart level.
6+
This will provide you end-to-end data lineage to understand your downstream dependencies, called exposures.
7+
8+
### Create a Personal Access Token
9+
10+
Elementary needs a Personal Access Token (PAT) to access the Lightdash API on your behalf.
11+
12+
1. In Lightdash, go to **Settings > Personal Access Tokens**.
13+
2. Click **Generate Token**.
14+
3. Give the token a descriptive name (e.g. "Elementary integration").
15+
4. Copy and save the generated token securely — you will need it when connecting Lightdash to Elementary.
16+
17+
For more details, refer to the [official Lightdash documentation](https://docs.lightdash.com/references/workspace/personal-tokens).
18+
19+
<Note>
20+
The token inherits the permissions of the user who created it. Make sure the user has access to all the projects you want Elementary to sync.
21+
</Note>
22+
23+
### Connecting Lightdash to Elementary
24+
25+
Navigate to the **Account settings > Environments** and choose the environment to which you would like to connect Lightdash.
26+
Choose the Lightdash BI connection and provide the following details to validate and complete the integration.
27+
28+
- **Connection Name:** A descriptive name for this Lightdash connection (e.g. "My Lightdash").
29+
- **API Token:** The Personal Access Token you generated in the previous step.
30+
- **Host URL** *(optional)*: Leave empty to use the default Lightdash Cloud URL (`https://app.lightdash.cloud`). Set this only if you are using a self-hosted Lightdash instance (e.g. `https://lightdash.mycompany.com`).
31+
- **Project UUIDs** *(optional)*: Leave empty to sync all projects in your Lightdash organization. Add specific project UUIDs to sync only those projects. You can find a project's UUID in the URL when viewing it in Lightdash (e.g. `https://app.lightdash.cloud/projects/<project-uuid>/...`).

docs/docs.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -233,6 +233,7 @@
233233
"cloud/integrations/bi/thoughtspot",
234234
"cloud/integrations/bi/mode",
235235
"cloud/integrations/bi/hex",
236+
"cloud/integrations/bi/lightdash",
236237
"cloud/integrations/bi/explo"
237238
]
238239
},

docs/snippets/cloud/integrations/cards-groups/bi-cards.mdx

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,16 @@
124124
</svg>
125125
}
126126
/>
127+
<Card
128+
title="Lightdash"
129+
href="/cloud/integrations/bi/lightdash"
130+
icon={
131+
<svg width="35" height="35" viewBox="0 0 35 35" fill="none" xmlns="http://www.w3.org/2000/svg">
132+
<rect width="35" height="35" rx="4" fill="#7262FF"/>
133+
<path d="M10 25V10h3v12h9v3H10z" fill="white"/>
134+
</svg>
135+
}
136+
/>
127137
<Card
128138
title="Metabase"
129139
href="https://tally.so/r/3N6DlW?integration=Metabase"

0 commit comments

Comments
 (0)