From 8a294f47fa50713acf03aa906d2b0322ff0ef6e9 Mon Sep 17 00:00:00 2001 From: Grant Colegate Date: Tue, 28 Nov 2023 09:51:27 +1030 Subject: [PATCH 1/2] Document filter runs by build_id --- .../rest_api/analytics/_runs_list_query_strings.md | 12 ++++++++++++ pages/apis/rest_api/analytics/runs.md | 4 ++++ 2 files changed, 16 insertions(+) create mode 100644 pages/apis/rest_api/analytics/_runs_list_query_strings.md diff --git a/pages/apis/rest_api/analytics/_runs_list_query_strings.md b/pages/apis/rest_api/analytics/_runs_list_query_strings.md new file mode 100644 index 0000000000..b8523174b9 --- /dev/null +++ b/pages/apis/rest_api/analytics/_runs_list_query_strings.md @@ -0,0 +1,12 @@ + + + + + + + +
+ build_id + + Filters the results by the given build UUID. +
diff --git a/pages/apis/rest_api/analytics/runs.md b/pages/apis/rest_api/analytics/runs.md index f2828cb046..4f5bec4a29 100644 --- a/pages/apis/rest_api/analytics/runs.md +++ b/pages/apis/rest_api/analytics/runs.md @@ -23,6 +23,10 @@ curl "https://api.buildkite.com/v2/analytics/organizations/{org.slug}/suites/{su ] ``` +Optional [query string parameters](/docs/api#query-string-parameters): + +<%= render_markdown partial: 'apis/rest_api/analytics/runs_list_query_strings' %> + Required scope: `read_suites` Success response: `200 OK` From 953373899cc3773260bf5143b7e8720e233aca83 Mon Sep 17 00:00:00 2001 From: Grant Colegate Date: Fri, 1 Dec 2023 11:36:52 +1030 Subject: [PATCH 2/2] Update pages/apis/rest_api/analytics/_runs_list_query_strings.md Add example for filtering runs by build id Co-authored-by: Gordon Chan --- pages/apis/rest_api/analytics/_runs_list_query_strings.md | 1 + 1 file changed, 1 insertion(+) diff --git a/pages/apis/rest_api/analytics/_runs_list_query_strings.md b/pages/apis/rest_api/analytics/_runs_list_query_strings.md index b8523174b9..f50570195d 100644 --- a/pages/apis/rest_api/analytics/_runs_list_query_strings.md +++ b/pages/apis/rest_api/analytics/_runs_list_query_strings.md @@ -6,6 +6,7 @@ Filters the results by the given build UUID. +

Example: ?build_id=018c133d-5419-7fe3-9e9e-3c51464490a2