Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create separate query parameters page for SL APIs #6781

Open
1 of 4 tasks
mirnawong1 opened this issue Jan 16, 2025 · 0 comments
Open
1 of 4 tasks

Create separate query parameters page for SL APIs #6781

mirnawong1 opened this issue Jan 16, 2025 · 0 comments
Assignees
Labels
content Improvements or additions to content idea Proposes an idea for new content improvement Use this when an area of the docs needs improvement as it's currently unclear priority: medium Fix or enhancement to existing information that’s creating some requests from customers size: medium This change will take up to a week to address

Comments

@mirnawong1
Copy link
Contributor

mirnawong1 commented Jan 16, 2025

Which of these best describes you?

  • dbt Community member
  • Partner
  • dbt Labs employee
  • Other

What's your idea for new content?

Feedback from @courtneyholcomb in pr #6775 (comment):

Not related to this PR, but I think at some point I think we should actually make a separate page for query parameters in general, since the same parameters apply to both APIs.

  • Then we could put all the details about how to write a where filter,
  • the purpose of a metric alias,
  • and what time grain does in one place,
  • then link to that from each of the API pages where we give examples of the specific syntax for that API.

Then we wouldn't have to explain the same things on both API pages. I think that would have helped with the issue yesterday, too, where people couldn't find the docs for where filters.

Where would you recommend this content live on the docs.getdbt.com?

separate page in: https://docs.getdbt.com/docs/dbt-cloud-apis/sl-api-overview

@mirnawong1 mirnawong1 added content Improvements or additions to content idea Proposes an idea for new content priority: medium Fix or enhancement to existing information that’s creating some requests from customers size: medium This change will take up to a week to address improvement Use this when an area of the docs needs improvement as it's currently unclear labels Jan 16, 2025
@mirnawong1 mirnawong1 self-assigned this Jan 16, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content Improvements or additions to content idea Proposes an idea for new content improvement Use this when an area of the docs needs improvement as it's currently unclear priority: medium Fix or enhancement to existing information that’s creating some requests from customers size: medium This change will take up to a week to address
Projects
None yet
Development

No branches or pull requests

1 participant