diff --git a/docs/dev/api/insights.md b/docs/dev/api/insights.md
index 67d624d925..0495d94207 100644
--- a/docs/dev/api/insights.md
+++ b/docs/dev/api/insights.md
@@ -24,7 +24,29 @@ Return run data for all tests that match the request criteria.
#### Parameters
+:::note
+This call requires start
and end
parameters OR the time_range
parameter.
+:::
+
start |
+ | QUERY | REQUIRED | DATE | The starting date of the period during which the test runs executed, in |
+
end |
+ | QUERY | REQUIRED | DATE | The ending date of the period during which the test runs executed, in |
+
time_range |
+ | QUERY | REQUIRED | DURATION + UNIT | The amount of time backward from the current time that represents the period during which the test runs are executed. Acceptable units include |
+
build |
@@ -43,12 +65,6 @@ Return run data for all tests that match the request criteria.
| QUERY | OPTIONAL | BOOLEAN | Sort results by test creation time. Default value is |
end |
- | QUERY | OPTIONAL | DATE | The ending date of the period during which the test runs executed, in |
-
error |
@@ -95,12 +111,6 @@ Return run data for all tests that match the request criteria.
| QUERY | OPTIONAL | INTEGER | The maximum number of results to return. Default value is |
start |
- | QUERY | OPTIONAL | DATE | The starting date of the period during which the test runs executed, in |
-
status |
@@ -118,15 +128,6 @@ Return run data for all tests that match the request criteria.
|
time_range |
-
- | QUERY | OPTIONAL | STRING | -The amount of time backward from the current time that represents the period during which the test runs are executed. Acceptable units include |
-
end
parameters OR the time_range
parameter.
+:::
+
start |
+ | QUERY | REQUIRED | DATE | The starting date of the period during which the test runs executed, in |
+ |||||||||||||||||||||||||||||
end |
+ | QUERY | REQUIRED | DATE | The ending date of the period during which the test runs executed, in |
+ |||||||||||||||||||||||||||||
time_range |
+ | QUERY | REQUIRED | DURATION + UNIT | The amount of time backward from the current time that represents the period during which the test runs are executed. Acceptable units include |
+ |||||||||||||||||||||||||||||
scope |
@@ -434,28 +457,10 @@ Return a set of data "buckets" representing tests that were run in each time int
interval |
| QUERY | OPTIONAL | STRING | -Relative date filter. Available values are:
1d
+ Relative date filter. Available values are:
1d
|
||||||||||||||||||||||||||||
time_range |
- | QUERY | OPTIONAL | STRING | The amount of time backward from the current time that represents the period during which the test runs are executed. Acceptable units include |
- |||||||||||||||||||||||||||||
start |
- | QUERY | OPTIONAL | DATE | The starting date of the period during which the test runs executed, in |
- |||||||||||||||||||||||||||||
end |
- | QUERY | OPTIONAL | DATE | The ending date of the period during which the test runs executed, in |
- |||||||||||||||||||||||||||||
browser |
@@ -1798,8 +1803,8 @@ Return an array of errors with occurrence count on all tests run in the specifie
||||||||||||||||||||||||||||||
interval |
- | QUERY | OPTIONAL | STRING | Relative date filter. Available values are:
1d |
+ | QUERY | OPTIONAL | STRING | Relative date filter. Available values are:
1d |
||||||||||||||||||||||||||||
interval |
- | QUERY | OPTIONAL | STRING | Relative date filter. Available values are:
1d |
+ | QUERY | OPTIONAL | STRING | Relative date filter. Available values are:
1d |
||||||||||||||||||||||||||||
interval |
- | QUERY | OPTIONAL | STRING | Relative date filter. Available values are:
1d |
+ | QUERY | OPTIONAL | STRING | Relative date filter. Available values are:
1d |
||||||||||||||||||||||||||||
interval |
- | QUERY | OPTIONAL | STRING | Relative date filter. Available values are:
1d |
+ | QUERY | OPTIONAL | STRING | Relative date filter. Available values are:
1d |
||||||||||||||||||||||||||||
interval |
- | QUERY | OPTIONAL | STRING | Relative date filter. Available values are:
1d |
+ | QUERY | OPTIONAL | STRING | Relative date filter. Available values are:
1d |
||||||||||||||||||||||||||||
interval |
- | QUERY | OPTIONAL | STRING | Relative date filter. Available values are:
1d |
+ | QUERY | OPTIONAL | STRING | Relative date filter. Available values are:
1d |
||||||||||||||||||||||||||||
interval |
- | QUERY | OPTIONAL | STRING | Relative date filter. Available values are:
1d |
+ | QUERY | OPTIONAL | STRING | Relative date filter. Available values are:
1d |
||||||||||||||||||||||||||||
interval |
- | QUERY | OPTIONAL | STRING | Relative date filter. Available values are:
1d |
+ | QUERY | OPTIONAL | STRING | Relative date filter. Available values are:
1d |
||||||||||||||||||||||||||||
interval |
- | QUERY | OPTIONAL | STRING | Relative date filter. Available values are:
1d |
+ | QUERY | OPTIONAL | STRING | Relative date filter. Available values are:
1d |
||||||||||||||||||||||||||||
interval |
- | QUERY | OPTIONAL | STRING | Relative date filter. Available values are:
1d |
+ | QUERY | OPTIONAL | STRING | Relative date filter. Available values are:
1d |