Load Testing API, gRPC: RegressionDashboardService.Get
Returns the specified regression dashboard.
To get the list of all available regression dashboards, make a List request.
gRPC request
rpc Get (GetRegressionDashboardRequest) returns (regression.Dashboard)
GetRegressionDashboardRequest
{
"dashboard_id": "string"
}
|
Field |
Description |
|
dashboard_id |
string Required field. ID of the dashboard to return. |
regression.Dashboard
{
"id": "string",
"name": "string",
"description": "string",
"created_at": "google.protobuf.Timestamp",
"updated_at": "google.protobuf.Timestamp",
"created_by": "string",
"updated_by": "string",
"etag": "string",
"content": {
"widgets": [
{
"position": {
"x": "int64",
"y": "int64",
"width": "int64",
"height": "int64"
},
// Includes only one of the fields `chart`, `text`, `title`
"chart": {
"id": "string",
"name": "string",
"description": "string",
"filter_str": "string",
"test_case": "string",
"kpis": [
{
"selector": {
// Includes only one of the fields `response_time`, `instances`, `imbalance_rps`, `protocol_codes_absolute`, `protocol_codes_relative`, `network_codes_absolute`, `network_codes_relative`
"response_time": {
"quantile": "QuantileType"
},
"instances": {
"agg": "Aggregation"
},
"imbalance_rps": "ImbalanceRps",
"protocol_codes_absolute": {
"codes_patterns": [
"string"
]
},
"protocol_codes_relative": {
"codes_patterns": [
"string"
]
},
"network_codes_absolute": {
"codes_patterns": [
"string"
]
},
"network_codes_relative": {
"codes_patterns": [
"string"
]
}
// end of the list of possible fields
},
"threshold": {
"value": "double",
"comparison": "Comparison"
}
}
]
},
"text": {
"text": "string"
},
"title": {
"text": "string",
"size": "TitleSize"
}
// 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. |
|
created_at |
Creation timestamp. |
|
updated_at |
Last update timestamp. |
|
created_by |
string UA or SA that created the dashboard. |
|
updated_by |
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 |
int64 X. |
|
y |
int64 Y. |
|
width |
int64 Width. |
|
height |
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. |
|
filter_str |
string Test filter selector to show KPI values for. |
|
test_case |
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 |
|
response_time |
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 |
|
imbalance_rps |
An RPS at the moment the test has been auto-stopped. Includes only one of the fields |
|
protocol_codes_absolute |
A total number of requests completed with certain protocol (HTTP, GRPC, etc.) codes. Includes only one of the fields |
|
protocol_codes_relative |
A percentage of requests completed with certain protocol (HTTP, GRPC, etc.) codes. Includes only one of the fields |
|
network_codes_absolute |
A total number of requests completed with certain network codes. Includes only one of the fields |
|
network_codes_relative |
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.
|
ImbalanceRps
Imbalance RPS.
|
Field |
Description |
|
Empty |
|
ProtocolCodesAbsolute
|
Field |
Description |
|
codes_patterns[] |
string Protocol (HTTP, GRPC) code patterns to match. All successful HTTP responses: ['2xx', '3xx']. |
ProtocolCodesRelative
|
Field |
Description |
|
codes_patterns[] |
string Protocol (HTTP, GRPC) code patterns to match. All successful HTTP responses: ['2xx', '3xx']. |
NetworkCodesAbsolute
|
Field |
Description |
|
codes_patterns[] |
string Network code patterns to match. All successful network responses: ['0']. |
NetworkCodesRelative
|
Field |
Description |
|
codes_patterns[] |
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 |
double 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.
|