Load Testing API, REST: RegressionDashboard.Get
Returns the specified regression dashboard.
To get the list of all available regression dashboards, make a List request.
HTTP request
GET https://loadtesting.api.cloud.yandex.net/loadtesting/api/v1/regressionDashboards/{dashboardId}
Path parameters
|
Field |
Description |
|
dashboardId |
string Required field. ID of the dashboard to return. |
Response
HTTP Code: 200 - OK
{
"id": "string",
"name": "string",
"description": "string",
"createdAt": "string",
"updatedAt": "string",
"createdBy": "string",
"updatedBy": "string",
"etag": "string",
"content": {
"widgets": [
{
"position": {
"x": "string",
"y": "string",
"width": "string",
"height": "string"
},
// Includes only one of the fields `chart`, `text`, `title`
"chart": {
"id": "string",
"name": "string",
"description": "string",
"filterStr": "string",
"testCase": "string",
"kpis": [
{
"selector": {
// Includes only one of the fields `responseTime`, `instances`, `imbalanceRps`, `protocolCodesAbsolute`, `protocolCodesRelative`, `networkCodesAbsolute`, `networkCodesRelative`
"responseTime": {
"quantile": "string"
},
"instances": {
"agg": "string"
},
"imbalanceRps": "object",
"protocolCodesAbsolute": {
"codesPatterns": [
"string"
]
},
"protocolCodesRelative": {
"codesPatterns": [
"string"
]
},
"networkCodesAbsolute": {
"codesPatterns": [
"string"
]
},
"networkCodesRelative": {
"codesPatterns": [
"string"
]
}
// end of the list of possible fields
},
"threshold": {
"value": "string",
"comparison": "string"
}
}
]
},
"text": {
"text": "string"
},
"title": {
"text": "string",
"size": "string"
}
// end of the list of possible fields
}
]
}
}
Regression dashboard.
|
Field |
Description |
|
id |
string ID of the dashboard. |
|
name |
string Name of the dashboard. |
|
description |
string Description of the dashboard. |
|
createdAt |
string (date-time) Creation timestamp. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the |
|
updatedAt |
string (date-time) Last update timestamp. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the |
|
createdBy |
string UA or SA that created the dashboard. |
|
updatedBy |
string UA or SA that updated the dashboard last time. |
|
etag |
string Etag of the dashboard. |
|
content |
Dashboard content. |
Content
Content of regression dashboard.
|
Field |
Description |
|
widgets[] |
Widgets. |
Widget
Regression dashboard widget.
|
Field |
Description |
|
position |
Widget position. |
|
chart |
Chart widget. Includes only one of the fields |
|
text |
Text widget. Includes only one of the fields |
|
title |
Title widget. Includes only one of the fields |
LayoutPosition
Widget position.
|
Field |
Description |
|
x |
string (int64) X. |
|
y |
string (int64) Y. |
|
width |
string (int64) Width. |
|
height |
string (int64) Height. |
ChartWidget
Regression chart.
|
Field |
Description |
|
id |
string ID of the chart. |
|
name |
string Name of the chart. |
|
description |
string Description of the chart. |
|
filterStr |
string Test filter selector to show KPI values for. |
|
testCase |
string Test case to show KPI values for. |
|
kpis[] |
KPIs to show. |
Kpi
KPI (Key Performance Indicator) represents some integral indicator measured during test.
|
Field |
Description |
|
selector |
Kind of KPI. |
|
threshold |
A condition that should be specified. |
KpiSelector
KPI selector.
|
Field |
Description |
|
responseTime |
Response time cummulative quantile (percentile). Includes only one of the fields |
|
instances |
A number of instances throughout the test. Includes only one of the fields |
|
imbalanceRps |
object An RPS at the moment the test has been auto-stopped. Includes only one of the fields |
|
protocolCodesAbsolute |
A total number of requests completed with certain protocol (HTTP, GRPC, etc.) codes. Includes only one of the fields |
|
protocolCodesRelative |
A percentage of requests completed with certain protocol (HTTP, GRPC, etc.) codes. Includes only one of the fields |
|
networkCodesAbsolute |
A total number of requests completed with certain network codes. Includes only one of the fields |
|
networkCodesRelative |
A percentage of requests completed with certain network codes. Includes only one of the fields |
ResponseTime
Response time.
|
Field |
Description |
|
quantile |
enum (QuantileType) Cummulative quantile (percentile).
|
Instances
Aggregated number of instances.
|
Field |
Description |
|
agg |
enum (Aggregation) Aggregation function.
|
ProtocolCodesAbsolute
|
Field |
Description |
|
codesPatterns[] |
string Protocol (HTTP, GRPC) code patterns to match. All successful HTTP responses: ['2xx', '3xx']. |
ProtocolCodesRelative
|
Field |
Description |
|
codesPatterns[] |
string Protocol (HTTP, GRPC) code patterns to match. All successful HTTP responses: ['2xx', '3xx']. |
NetworkCodesAbsolute
|
Field |
Description |
|
codesPatterns[] |
string Network code patterns to match. All successful network responses: ['0']. |
NetworkCodesRelative
|
Field |
Description |
|
codesPatterns[] |
string Network code patterns to match. All successful network responses: ['0']. |
KpiThreshold
KPI threshold represents a condition that an actual value of test's KPI should satisfy.
|
Field |
Description |
|
value |
string Value for comparison with an actual KPI value. |
|
comparison |
enum (Comparison) Comparison operator for comparing actual with the threshold value. Rule: actual (</<=/>/>=) reference
|
TextWidget
Text widget.
|
Field |
Description |
|
text |
string Text string. |
TitleWidget
Title widget.
|
Field |
Description |
|
text |
string Title string. |
|
size |
enum (TitleSize) Title size.
|