From de3a004e46386af7fb7358ae8269d962ee75299b Mon Sep 17 00:00:00 2001 From: Adam E <159158755+adam-saucelabs@users.noreply.github.com> Date: Mon, 25 Nov 2024 10:08:13 -0600 Subject: [PATCH] start/end/time_range consistency updates updating copy for start/end/time_range and parameter sorting for - /v1/analytics/tests - /v1/analytics/insights/test-metrics - /v1/analytics/trends/tests - /v1/analytics/trends/builds_tests --- docs/dev/api/insights.md | 75 +++++++++++++++++++--------------------- 1 file changed, 36 insertions(+), 39 deletions(-) diff --git a/docs/dev/api/insights.md b/docs/dev/api/insights.md index 0062f1c456..9727a49997 100644 --- a/docs/dev/api/insights.md +++ b/docs/dev/api/insights.md @@ -29,6 +29,24 @@ This call requires start and end parameters OR the + + + start +

| QUERY | REQUIRED | DATE |

The starting date of the period during which the test runs executed, in YYYY-MM-DDTHH:mm:ssZ (UTC) format.

+ + + + + end +

| QUERY | REQUIRED | DATE |

The ending date of the period during which the test runs executed, in YYYY-MM-DDTHH:mm:ssZ (UTC) format.

+ + + + + 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 d (day); h (hour); m (minute); s (second).

+ + build @@ -47,12 +65,6 @@ This call requires start and end parameters OR the

| QUERY | OPTIONAL | BOOLEAN |

Sort results by test creation time. Default value is true.

- - - end -

| QUERY | OPTIONAL | DATE |

The ending date of the period during which the test runs executed, in YYYY-MM-DDTHH:mm:ssZ (UTC) format.

- - error @@ -99,12 +111,6 @@ This call requires start and end parameters OR the

| QUERY | OPTIONAL | INTEGER |

The maximum number of results to return. Default value is 10

- - - start -

| QUERY | OPTIONAL | DATE |

The starting date of the period during which the test runs executed, in YYYY-MM-DDTHH:mm:ssZ (UTC) format.

- - status @@ -122,15 +128,6 @@ This call requires start and end parameters OR the - - - 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 d (day); h (hour); m (minute); s (second).

- - - start and end parameters OR the + + + start +

| QUERY | REQUIRED | DATE |

The starting date of the period during which the test runs executed, in YYYY-MM-DDTHH:mm:ssZ (UTC) format.

+ + + + + end +

| QUERY | REQUIRED | DATE |

The ending date of the period during which the test runs executed, in YYYY-MM-DDTHH:mm:ssZ (UTC) format.

+ + + + + 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 d (day); h (hour); m (minute); s (second).

+ + scope @@ -446,24 +461,6 @@ This call requires start and end parameters OR the - - - 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 d (day); h (hour); m (minute); s (second).

- - - - - start -

| QUERY | OPTIONAL | DATE |

The starting date of the period during which the test runs executed, in YYYY-MM-DDTHH:mm:ssZ (UTC) format.

- - - - - end -

| QUERY | OPTIONAL | DATE |

The ending date of the period during which the test runs executed, in YYYY-MM-DDTHH:mm:ssZ (UTC) format.

- - browser