Document field-level tags for API filtering#502
Merged
Conversation
Generated-By: mintlify-agent
Contributor
🤖 Documentation Bot✅ All checks passed! No issues found. |
Generated-By: mintlify-agent
Contributor
🤖 Documentation Bot✅ All checks passed! No issues found. |
Generated-By: mintlify-agent
Contributor
🤖 Documentation Bot✅ All checks passed! No issues found. |
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
Field-level tags on metrics and dimensions are already supported by Lightdash but were only documented in the AI agents context. This PR surfaces them as a general-purpose feature across the reference docs and API recipes.
Changes
references/dimensions.mdx): Addedtagsproperty to the configuration table and a new "Tags" section with syntax examples (dbt v1.9, v1.10+, Lightdash YAML)references/metrics.mdx): Addedtagsproperty to the configuration table and a new "Tags" section with syntax examplesapi-reference/v1/recipes.mdx): Added a new recipe showing how to filter metrics by tag using the/api/v2/projects/{projectUuid}/dataCatalog/metrics-with-time-dimensionsendpoint, including query parameters and example responseContext
A customer building a headless metrics store pipeline needed to flag specific metrics for API ingestion without tagging entire models. The
tagsfeature and API filter already exist — this PR ensures they are documented outside the AI agents guides.