docs: add Metrics SQL API integration page#992
Merged
Conversation
Documents the new Postgres wire protocol compatible interface for querying the Lightdash semantic layer. Covers connection details, the querying model, examples, and current limitations, based on PROD-8742/PROD-8743/PROD-8835. Marked as beta and Enterprise-only.
Contributor
🤖 Documentation BotStatus🔗 Broken Links (Manual Fix Required)Click to view details |
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
🤖 Documentation BotStatus🔗 Broken Links (Manual Fix Required)Click to view details |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a new Metrics SQL API page under the Integrations section, documenting the Postgres wire protocol compatible interface for querying the Lightdash semantic layer.
The page covers:
pg.<instance>.lightdash.cloud), port 5432, database = project UUID, token-based auth (service account token recommended, PAT supported),sslmode=disablerequirement with a TLS warning, and a pointer to the new project settings pageGROUP BY, supported SQL surface, 500-row default limitinformation_schema, metric queries, filters, calculated expressions, and Python via psycopg2pg_catalogemulationContent is based on PROD-8742 (docs spec), PROD-8743 (settings page spec), and PROD-8835 (implementation findings).
Notes for reviewers
mint broken-linkspasses.