Skip to content

Commit

Permalink
start/end/time_range consistency updates
Browse files Browse the repository at this point in the history 
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
  • Loading branch information
@adam-saucelabs
adam-saucelabs authored Nov 25, 2024
1 parent a58f9fa commit de3a004
Showing 1 changed file with 36 additions and 39 deletions.
75 changes: 36 additions & 39 deletions docs/dev/api/insights.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,24 @@ This call requires <code>start</code> and <code>end</code> parameters OR the <co
:::

<table id="table-api">
<tbody>
<tr>
<td><code>start</code></td>
<td><p><small>| QUERY | REQUIRED | DATE |</small></p><p>The starting date of the period during which the test runs executed, in <code>YYYY-MM-DDTHH:mm:ssZ</code> (UTC) format.</p></td>
</tr>
</tbody>
<tbody>
<tr>
<td><code>end</code></td>
<td><p><small>| QUERY | REQUIRED | DATE |</small></p><p>The ending date of the period during which the test runs executed, in <code>YYYY-MM-DDTHH:mm:ssZ</code> (UTC) format.</p></td>
</tr>
</tbody>
<tbody>
<tr>
<td><code>time_range</code></td>
<td><p><small>| QUERY | REQUIRED | DURATION + UNIT |</small></p><p>The amount of time backward from the current time that represents the period during which the test runs are executed. Acceptable units include <code>d</code> (day); <code>h</code> (hour); <code>m</code> (minute); <code>s</code> (second).</p></td>
</tr>
</tbody>
<tbody>
<tr>
<td><code>build</code></td>
Expand All @@ -47,12 +65,6 @@ This call requires <code>start</code> and <code>end</code> parameters OR the <co
<td><p><small>| QUERY | OPTIONAL | BOOLEAN |</small></p><p>Sort results by test creation time. Default value is <code>true</code>.</p></td>
</tr>
</tbody>
<tbody>
<tr>
<td><code>end</code></td>
<td><p><small>| QUERY | OPTIONAL | DATE |</small></p><p>The ending date of the period during which the test runs executed, in <code>YYYY-MM-DDTHH:mm:ssZ</code> (UTC) format.</p></td>
</tr>
</tbody>
<tbody>
<tr>
<td><code>error</code></td>
Expand Down Expand Up @@ -99,12 +111,6 @@ This call requires <code>start</code> and <code>end</code> parameters OR the <co
<td><p><small>| QUERY | OPTIONAL | INTEGER |</small></p><p>The maximum number of results to return. Default value is <code>10</code></p></td>
</tr>
</tbody>
<tbody>
<tr>
<td><code>start</code></td>
<td><p><small>| QUERY | OPTIONAL | DATE |</small></p><p>The starting date of the period during which the test runs executed, in <code>YYYY-MM-DDTHH:mm:ssZ</code> (UTC) format.</p></td>
</tr>
</tbody>
<tbody>
<tr>
<td><code>status</code></td>
Expand All @@ -122,15 +128,6 @@ This call requires <code>start</code> and <code>end</code> parameters OR the <co
</td>
</tr>
</tbody>
<tbody>
<tr>
<td><code>time_range</code></td>
<td>
<p><small>| QUERY | OPTIONAL | STRING |</small></p>
<p>The amount of time backward from the current time that represents the period during which the test runs are executed. Acceptable units include <code>d</code> (day); <code>h</code> (hour); <code>m</code> (minute); <code>s</code> (second).</p>
</td>
</tr>
</tbody>
</table>

<Tabs
Expand Down Expand Up @@ -421,6 +418,24 @@ This call requires <code>start</code> and <code>end</code> parameters OR the <co
:::

<table id="table-api">
<tbody>
<tr>
<td><code>start</code></td>
<td><p><small>| QUERY | REQUIRED | DATE |</small></p><p>The starting date of the period during which the test runs executed, in <code>YYYY-MM-DDTHH:mm:ssZ</code> (UTC) format.</p></td>
</tr>
</tbody>
<tbody>
<tr>
<td><code>end</code></td>
<td><p><small>| QUERY | REQUIRED | DATE |</small></p><p>The ending date of the period during which the test runs executed, in <code>YYYY-MM-DDTHH:mm:ssZ</code> (UTC) format.</p></td>
</tr>
</tbody>
<tbody>
<tr>
<td><code>time_range</code></td>
<td><p><small>| QUERY | REQUIRED | DURATION + UNIT |</small></p><p>The amount of time backward from the current time that represents the period during which the test runs are executed. Acceptable units include <code>d</code> (day); <code>h</code> (hour); <code>m</code> (minute); <code>s</code> (second).</p></td>
</tr>
</tbody>
<tbody>
<tr>
<td><code>scope</code></td>
Expand All @@ -446,24 +461,6 @@ This call requires <code>start</code> and <code>end</code> parameters OR the <co
</td>
</tr>
</tbody>
<tbody>
<tr>
<td><code>time_range</code></td>
<td><p><small>| QUERY | OPTIONAL | STRING |</small></p><p>The amount of time backward from the current time that represents the period during which the test runs are executed. Acceptable units include <code>d</code> (day); <code>h</code> (hour); <code>m</code> (minute); <code>s</code> (second).</p></td>
</tr>
</tbody>
<tbody>
<tr>
<td><code>start</code></td>
<td><p><small>| QUERY | OPTIONAL | DATE |</small></p><p>The starting date of the period during which the test runs executed, in <code>YYYY-MM-DDTHH:mm:ssZ</code> (UTC) format.</p></td>
</tr>
</tbody>
<tbody>
<tr>
<td><code>end</code></td>
<td><p><small>| QUERY | OPTIONAL | DATE |</small></p><p>The ending date of the period during which the test runs executed, in <code>YYYY-MM-DDTHH:mm:ssZ</code> (UTC) format.</p></td>
</tr>
</tbody>
<tbody>
<tr>
<td><code>browser</code></td>
Expand Down

0 comments on commit de3a004

Please sign in to comment.