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. +::: + + + + + + + + + + + + + + + + + + + @@ -43,12 +65,6 @@ Return run data for all tests that match the request criteria. - - - - - - @@ -95,12 +111,6 @@ Return run data for all tests that match the request criteria. - - - - - - @@ -118,15 +128,6 @@ Return run data for all tests that match the request criteria. - - - - - -
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

| 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

| 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
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 time_range parameter. +::: + + + + + + + + + + + + + + + + + + + @@ -434,28 +457,10 @@ Return a set of data "buckets" representing tests that were run in each time int - - - - - - - - - - - - - - - - - - @@ -1798,8 +1803,8 @@ Return an array of errors with occurrence count on all tests run in the specifie

| QUERY | OPTIONAL | STRING |

Relative date filter. Available values are:

- + @@ -2590,7 +2595,7 @@ Return an array of test cases (grouped by name) with statistical details. - + @@ -2806,7 +2811,7 @@ Return an array of test cases (grouped by name) with statistical details as a CS - + @@ -3002,7 +3007,7 @@ Return an array of test cases (grouped by name) with statistical details. - + @@ -3516,7 +3521,7 @@ Return information about tests coverage for the specified coverage_field - + @@ -3800,7 +3805,7 @@ Return information about tests coverage for the specified `coverage_field` in a - + @@ -4036,7 +4041,7 @@ Return an array of buckets with aggregations, such as number of tests run on a s - + @@ -4322,7 +4327,7 @@ Return an array of buckets with aggregations, such as the number of tests from a - + @@ -4620,7 +4625,7 @@ Return statistics for errors that occurred in tests run in the specified period. - + @@ -5004,7 +5009,7 @@ Return information about builds and tests run included in the build. Also, it pr - +
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).

scopeinterval

| QUERY | OPTIONAL | STRING |

-

Relative date filter. Available values are:

  • 1m (1 month)
  • 15m (15 months)
  • 1h (1 hour)
  • 6h (6 hours)
  • 12h (12 hours)
  • 1d (1 day)
  • 7d (7 days)
  • 30d (30 days)
Default value is 1d

+

Relative date filter. Available values are:

  • 1m (1 minute)
  • 15m (15 minutes)
  • 1h (1 hour)
  • 6h (6 hours)
  • 12h (12 hours)
  • 1d (1 day)
  • 7d (7 days)
  • 30d (30 days)
Default value is 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 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
interval

| QUERY | OPTIONAL | STRING |

Relative date filter. Available values are:

  • 1m (1 month)
  • 15m (15 months)
  • 1h (1 hour)
  • 6h (6 hours)
  • 12h (12 hours)
  • 1d (1 day)
  • 7d (7 days)
  • 30d (30 days)
Default value is 1d

| QUERY | OPTIONAL | STRING |

Relative date filter. Available values are:

  • 1m (1 minute)
  • 15m (15 minutes)
  • 1h (1 hour)
  • 6h (6 hours)
  • 12h (12 hours)
  • 1d (1 day)
  • 7d (7 days)
  • 30d (30 days)
Default value is 1d

interval

| QUERY | OPTIONAL | STRING |

Relative date filter. Available values are:

  • 1m (1 month)
  • 15m (15 months)
  • 1h (1 hour)
  • 6h (6 hours)
  • 12h (12 hours)
  • 1d (1 day)
  • 7d (7 days)
  • 30d (30 days)
Default value is 1d

| QUERY | OPTIONAL | STRING |

Relative date filter. Available values are:

  • 1m (1 minute)
  • 15m (15 minutes)
  • 1h (1 hour)
  • 6h (6 hours)
  • 12h (12 hours)
  • 1d (1 day)
  • 7d (7 days)
  • 30d (30 days)
Default value is 1d

interval

| QUERY | OPTIONAL | STRING |

Relative date filter. Available values are:

  • 1m (1 month)
  • 15m (15 months)
  • 1h (1 hour)
  • 6h (6 hours)
  • 12h (12 hours)
  • 1d (1 day)
  • 7d (7 days)
  • 30d (30 days)
Default value is 1d

| QUERY | OPTIONAL | STRING |

Relative date filter. Available values are:

  • 1m (1 minute)
  • 15m (15 minutes)
  • 1h (1 hour)
  • 6h (6 hours)
  • 12h (12 hours)
  • 1d (1 day)
  • 7d (7 days)
  • 30d (30 days)
Default value is 1d

interval

| QUERY | OPTIONAL | STRING |

Relative date filter. Available values are:

  • 1m (1 month)
  • 15m (15 months)
  • 1h (1 hour)
  • 6h (6 hours)
  • 12h (12 hours)
  • 1d (1 day)
  • 7d (7 days)
  • 30d (30 days)
Default value is 1d

| QUERY | OPTIONAL | STRING |

Relative date filter. Available values are:

  • 1m (1 minute)
  • 15m (15 minutes)
  • 1h (1 hour)
  • 6h (6 hours)
  • 12h (12 hours)
  • 1d (1 day)
  • 7d (7 days)
  • 30d (30 days)
Default value is 1d

interval

| QUERY | OPTIONAL | STRING |

Relative date filter. Available values are:

  • 1m (1 month)
  • 15m (15 months)
  • 1h (1 hour)
  • 6h (6 hours)
  • 12h (12 hours)
  • 1d (1 day)
  • 7d (7 days)
  • 30d (30 days)
Default value is 1d

| QUERY | OPTIONAL | STRING |

Relative date filter. Available values are:

  • 1m (1 minute)
  • 15m (15 minutes)
  • 1h (1 hour)
  • 6h (6 hours)
  • 12h (12 hours)
  • 1d (1 day)
  • 7d (7 days)
  • 30d (30 days)
Default value is 1d

interval

| QUERY | OPTIONAL | STRING |

Relative date filter. Available values are:

  • 1m (1 month)
  • 15m (15 months)
  • 1h (1 hour)
  • 6h (6 hours)
  • 12h (12 hours)
  • 1d (1 day)
  • 7d (7 days)
  • 30d (30 days)
Default value is 1d

| QUERY | OPTIONAL | STRING |

Relative date filter. Available values are:

  • 1m (1 minute)
  • 15m (15 minutes)
  • 1h (1 hour)
  • 6h (6 hours)
  • 12h (12 hours)
  • 1d (1 day)
  • 7d (7 days)
  • 30d (30 days)
Default value is 1d

interval

| QUERY | OPTIONAL | STRING |

Relative date filter. Available values are:

  • 1m (1 month)
  • 15m (15 months)
  • 1h (1 hour)
  • 6h (6 hours)
  • 12h (12 hours)
  • 1d (1 day)
  • 7d (7 days)
  • 30d (30 days)
Default value is 1d

| QUERY | OPTIONAL | STRING |

Relative date filter. Available values are:

  • 1m (1 minute)
  • 15m (15 minutes)
  • 1h (1 hour)
  • 6h (6 hours)
  • 12h (12 hours)
  • 1d (1 day)
  • 7d (7 days)
  • 30d (30 days)
Default value is 1d

interval

| QUERY | OPTIONAL | STRING |

Relative date filter. Available values are:

  • 1m (1 month)
  • 15m (15 months)
  • 1h (1 hour)
  • 6h (6 hours)
  • 12h (12 hours)
  • 1d (1 day)
  • 7d (7 days)
  • 30d (30 days)
Default value is 1d

| QUERY | OPTIONAL | STRING |

Relative date filter. Available values are:

  • 1m (1 minute)
  • 15m (15 minutes)
  • 1h (1 hour)
  • 6h (6 hours)
  • 12h (12 hours)
  • 1d (1 day)
  • 7d (7 days)
  • 30d (30 days)
Default value is 1d

interval

| QUERY | OPTIONAL | STRING |

Relative date filter. Available values are:

  • 1m (1 month)
  • 15m (15 months)
  • 1h (1 hour)
  • 6h (6 hours)
  • 12h (12 hours)
  • 1d (1 day)
  • 7d (7 days)
  • 30d (30 days)
Default value is 1d

| QUERY | OPTIONAL | STRING |

Relative date filter. Available values are:

  • 1m (1 minute)
  • 15m (15 minutes)
  • 1h (1 hour)
  • 6h (6 hours)
  • 12h (12 hours)
  • 1d (1 day)
  • 7d (7 days)
  • 30d (30 days)
Default value is 1d

interval

| QUERY | OPTIONAL | STRING |

Relative date filter. Available values are:

  • 1m (1 month)
  • 15m (15 months)
  • 1h (1 hour)
  • 6h (6 hours)
  • 12h (12 hours)
  • 1d (1 day)
  • 7d (7 days)
  • 30d (30 days)
Default value is 1d

| QUERY | OPTIONAL | STRING |

Relative date filter. Available values are:

  • 1m (1 minute)
  • 15m (15 minutes)
  • 1h (1 hour)
  • 6h (6 hours)
  • 12h (12 hours)
  • 1d (1 day)
  • 7d (7 days)
  • 30d (30 days)
Default value is 1d