dbt-labs / dbt-labs/docs.getdbt.com

Update API docs to show examples to show array query params

Open
#6,086 0 comments 0 reactions 0 assignees View on GitHub
content improvement
Dominant language
JavaScript
Stars
215
Forks
1.2k
Avg merge
1d 15h
Merged PRs (30d)
130

Description

### Contributions

- [X] I have read the contribution docs, and understand what's expected of me.

### Link to the page on docs.getdbt.com requiring updates

https://docs.getdbt.com/dbt-cloud/api-v2#/operations/List%20Runs

### What part(s) of the page would you like to see updated?

With ref to Slack [thread](https://dbt-labs.slack.com/archives/C02NCQ9483C/p1722871168091499) raised by Miguel in CS, an enterprise customer raised some feedback about the [List Run API](https://docs.getdbt.com/dbt-cloud/api-v2#/operations/List%20Runs).

They mentioned they experienced some issues figuring the format to pass the values as range and suggested it would help if there were a few examples involving array query params.

Miguel mentioned, whilst the documentation says that the finished_at__range field should be an array, he thinks it may better if there are samples. He found a resolution with `finished_at__range` being `["{start_date}"`, `"{end_date}"]` like `["yyyy-mm-dd", "yyyy-mm-dd"]` or `["yyyy-mm-dd hh:mm:ss"`, `"yyyy-mm-dd hh:mm:ss"] `.

### Additional information

![APIexample1](https://github.com/user-attachments/assets/2c95a1fc-7b3f-4a44-849a-2cf37191adf1)
![APIexample2](https://github.com/user-attachments/assets/6c86246a-622f-45d7-afc9-061c419b2b65)

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.