Load Testing API, REST: RegressionDashboard.Update

Written by

Updated at December 17, 2024

HTTP request
Path parameters
Body parameters
Content
Widget
LayoutPosition
ChartWidget
Kpi
KpiSelector
ResponseTime
Instances
ProtocolCodesAbsolute
ProtocolCodesRelative
NetworkCodesAbsolute
NetworkCodesRelative
KpiThreshold
TextWidget
TitleWidget
Response
UpdateRegressionDashboardMetadata
Status
Dashboard
Content
Widget
LayoutPosition
ChartWidget
Kpi
KpiSelector
ResponseTime
Instances
ProtocolCodesAbsolute
ProtocolCodesRelative
NetworkCodesAbsolute
NetworkCodesRelative
KpiThreshold
TextWidget
TitleWidget

Updates the specified regression dashboard.

HTTP request

PATCH https://loadtesting.api.cloud.yandex.net/loadtesting/api/v1/regressionDashboards/{dashboardId}

Path parameters

Field

Description

dashboardId

string

Required field. ID of the dashboards to update.

Body parameters

{
  "etag": "string",
  "updateMask": "object",
  "name": "string",
  "description": "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
      }
    ]
  }
}

Field	Description
etag	string The current etag of the dashboard.
updateMask	object (field-mask) A comma-separated names off ALL fields to be updated. Only the specified fields will be changed. The others will be left untouched. If the field is specified in `updateMask` and no value for that field was sent in the request, the field's value will be reset to the default. The default value for most fields is null or 0. If `updateMask` is not sent in the request, all fields' values will be updated. Fields specified in the request will be updated to provided values. The rest of the fields will be reset to the default.
name	string New name of the dashboard.
description	string New description of the dashboard.
content	Content New content of the dashboard.

Content

Content of regression dashboard.

Field

Description

widgets[]

Widget

Widgets.

Regression dashboard widget.

Field	Description
position	LayoutPosition Widget position.
chart	ChartWidget Chart widget. Includes only one of the fields `chart`, `text`, `title`.
text	TextWidget Text widget. Includes only one of the fields `chart`, `text`, `title`.
title	TitleWidget Title widget. Includes only one of the fields `chart`, `text`, `title`.

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[]	Kpi KPIs to show.

Kpi

KPI (Key Performance Indicator) represents some integral indicator measured during test.

Field

Description

selector

KpiSelector

Kind of KPI.

threshold

KpiThreshold

A condition that should be specified.

KpiSelector

KPI selector.

Field	Description
responseTime	ResponseTime Response time cummulative quantile (percentile). Includes only one of the fields `responseTime`, `instances`, `imbalanceRps`, `protocolCodesAbsolute`, `protocolCodesRelative`, `networkCodesAbsolute`, `networkCodesRelative`.
instances	Instances A number of instances throughout the test. Includes only one of the fields `responseTime`, `instances`, `imbalanceRps`, `protocolCodesAbsolute`, `protocolCodesRelative`, `networkCodesAbsolute`, `networkCodesRelative`.
imbalanceRps	object An RPS at the moment the test has been auto-stopped. Includes only one of the fields `responseTime`, `instances`, `imbalanceRps`, `protocolCodesAbsolute`, `protocolCodesRelative`, `networkCodesAbsolute`, `networkCodesRelative`.
protocolCodesAbsolute	ProtocolCodesAbsolute A total number of requests completed with certain protocol (HTTP, GRPC, etc.) codes. Includes only one of the fields `responseTime`, `instances`, `imbalanceRps`, `protocolCodesAbsolute`, `protocolCodesRelative`, `networkCodesAbsolute`, `networkCodesRelative`.
protocolCodesRelative	ProtocolCodesRelative A percentage of requests completed with certain protocol (HTTP, GRPC, etc.) codes. Includes only one of the fields `responseTime`, `instances`, `imbalanceRps`, `protocolCodesAbsolute`, `protocolCodesRelative`, `networkCodesAbsolute`, `networkCodesRelative`.
networkCodesAbsolute	NetworkCodesAbsolute A total number of requests completed with certain network codes. Includes only one of the fields `responseTime`, `instances`, `imbalanceRps`, `protocolCodesAbsolute`, `protocolCodesRelative`, `networkCodesAbsolute`, `networkCodesRelative`.
networkCodesRelative	NetworkCodesRelative A percentage of requests completed with certain network codes. Includes only one of the fields `responseTime`, `instances`, `imbalanceRps`, `protocolCodesAbsolute`, `protocolCodesRelative`, `networkCodesAbsolute`, `networkCodesRelative`.

ResponseTime

Response time.

Field

Description

quantile

enum (QuantileType)

Cummulative quantile (percentile).

QUANTILE_TYPE_UNSPECIFIED: Unspecified percentile.
QUANTILE_TYPE_50: 50 percentile (median).
QUANTILE_TYPE_75: 75 percentile.
QUANTILE_TYPE_80: 80 percentile.
QUANTILE_TYPE_85: 85 percentile.
QUANTILE_TYPE_90: 90 percentile.
QUANTILE_TYPE_95: 95 percentile.
QUANTILE_TYPE_98: 98 percentile.
QUANTILE_TYPE_99: 99 percentile.
QUANTILE_TYPE_100: 100 percentile (maximum or minimum).

Instances

Aggregated number of instances.

Field

Description

agg

enum (Aggregation)

Aggregation function.

AGGREGATION_UNSPECIFIED: Unspecified.
AGGREGATION_MIN: Minimum.
AGGREGATION_MAX: Maximum.
AGGREGATION_AVG: Average.
AGGREGATION_MEDIAN: Median.
AGGREGATION_STD_DEV: Standard deviation.

ProtocolCodesAbsolute

Field

Description

codesPatterns[]

string

Protocol (HTTP, GRPC) code patterns to match.

All successful HTTP responses: ['2xx', '3xx'].
All failed HTTP responses: ['0', '4xx', '5xx'].

ProtocolCodesRelative

Field

Description

codesPatterns[]

string

Protocol (HTTP, GRPC) code patterns to match.

All successful HTTP responses: ['2xx', '3xx'].
All failed HTTP responses: ['0', '4xx', '5xx'].

NetworkCodesAbsolute

Field

Description

codesPatterns[]

string

Network code patterns to match.

All successful network responses: ['0'].
All failed network responses: ['xx', 'xxx'].

NetworkCodesRelative

Field

Description

codesPatterns[]

string

Network code patterns to match.

All successful network responses: ['0'].
All failed network responses: ['xx', 'xxx'].

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

COMPARISON_UNSPECIFIED: Unspecified.
COMPARISON_LT: Less than the specified value.
COMPARISON_LTE: Less than or equal to the specified value.
COMPARISON_GT: Greater than the specified value.
COMPARISON_GTE: Greater than or equal to the specified value.

TextWidget

Text widget.

Field

Description

text

string

Text string.

TitleWidget

Title widget.

Field

Description

text

string

Title string.

size

enum (TitleSize)

Title size.

TITLE_SIZE_UNSPECIFIED: Unspecified.
TITLE_SIZE_XS: Extra small.
TITLE_SIZE_S: Small.
TITLE_SIZE_M: Medium.
TITLE_SIZE_L: Large.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": "boolean",
  "metadata": {
    "dashboardId": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": {
    "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
        }
      ]
    }
  }
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
createdAt	string (date-time) Creation timestamp. String in RFC3339 text format. The range of possible values is from `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).
createdBy	string ID of the user or service account who initiated the operation.
modifiedAt	string (date-time) The time when the Operation resource was last modified. String in RFC3339 text format. The range of possible values is from `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).
done	boolean If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
metadata	UpdateRegressionDashboardMetadata Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
error	Status The error result of the operation in case of failure or cancellation. Includes only one of the fields `error`, `response`. The operation result. If `done == false` and there was no failure detected, neither `error` nor `response` is set. If `done == false` and there was a failure detected, `error` is set. If `done == true`, exactly one of `error` or `response` is set.
response	Dashboard The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any. Includes only one of the fields `error`, `response`. The operation result. If `done == false` and there was no failure detected, neither `error` nor `response` is set. If `done == false` and there was a failure detected, `error` is set. If `done == true`, exactly one of `error` or `response` is set.

UpdateRegressionDashboardMetadata

Field

Description

dashboardId

string

ID of the dashboard that is being updated.

Status

The error result of the operation in case of failure or cancellation.

Field	Description
code	integer (int32) Error code. An enum value of google.rpc.Code.
message	string An error message.
details[]	object A list of messages that carry the error details.

Dashboard

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 `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).
updatedAt	string (date-time) Last update timestamp. String in RFC3339 text format. The range of possible values is from `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).
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	Content Dashboard content.

Content

Content of regression dashboard.

Field

Description

widgets[]

Widget

Widgets.

Widget

Regression dashboard widget.

Field	Description
position	LayoutPosition Widget position.
chart	ChartWidget Chart widget. Includes only one of the fields `chart`, `text`, `title`.
text	TextWidget Text widget. Includes only one of the fields `chart`, `text`, `title`.
title	TitleWidget Title widget. Includes only one of the fields `chart`, `text`, `title`.

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[]	Kpi KPIs to show.

Kpi

KPI (Key Performance Indicator) represents some integral indicator measured during test.

Field

Description

selector

KpiSelector

Kind of KPI.

threshold

KpiThreshold

A condition that should be specified.

KpiSelector

KPI selector.

Field	Description
responseTime	ResponseTime Response time cummulative quantile (percentile). Includes only one of the fields `responseTime`, `instances`, `imbalanceRps`, `protocolCodesAbsolute`, `protocolCodesRelative`, `networkCodesAbsolute`, `networkCodesRelative`.
instances	Instances A number of instances throughout the test. Includes only one of the fields `responseTime`, `instances`, `imbalanceRps`, `protocolCodesAbsolute`, `protocolCodesRelative`, `networkCodesAbsolute`, `networkCodesRelative`.
imbalanceRps	object An RPS at the moment the test has been auto-stopped. Includes only one of the fields `responseTime`, `instances`, `imbalanceRps`, `protocolCodesAbsolute`, `protocolCodesRelative`, `networkCodesAbsolute`, `networkCodesRelative`.
protocolCodesAbsolute	ProtocolCodesAbsolute A total number of requests completed with certain protocol (HTTP, GRPC, etc.) codes. Includes only one of the fields `responseTime`, `instances`, `imbalanceRps`, `protocolCodesAbsolute`, `protocolCodesRelative`, `networkCodesAbsolute`, `networkCodesRelative`.
protocolCodesRelative	ProtocolCodesRelative A percentage of requests completed with certain protocol (HTTP, GRPC, etc.) codes. Includes only one of the fields `responseTime`, `instances`, `imbalanceRps`, `protocolCodesAbsolute`, `protocolCodesRelative`, `networkCodesAbsolute`, `networkCodesRelative`.
networkCodesAbsolute	NetworkCodesAbsolute A total number of requests completed with certain network codes. Includes only one of the fields `responseTime`, `instances`, `imbalanceRps`, `protocolCodesAbsolute`, `protocolCodesRelative`, `networkCodesAbsolute`, `networkCodesRelative`.
networkCodesRelative	NetworkCodesRelative A percentage of requests completed with certain network codes. Includes only one of the fields `responseTime`, `instances`, `imbalanceRps`, `protocolCodesAbsolute`, `protocolCodesRelative`, `networkCodesAbsolute`, `networkCodesRelative`.

ResponseTime

Response time.

Field

Description

quantile

enum (QuantileType)

Cummulative quantile (percentile).

QUANTILE_TYPE_UNSPECIFIED: Unspecified percentile.
QUANTILE_TYPE_50: 50 percentile (median).
QUANTILE_TYPE_75: 75 percentile.
QUANTILE_TYPE_80: 80 percentile.
QUANTILE_TYPE_85: 85 percentile.
QUANTILE_TYPE_90: 90 percentile.
QUANTILE_TYPE_95: 95 percentile.
QUANTILE_TYPE_98: 98 percentile.
QUANTILE_TYPE_99: 99 percentile.
QUANTILE_TYPE_100: 100 percentile (maximum or minimum).

Instances

Aggregated number of instances.

Field

Description

agg

enum (Aggregation)

Aggregation function.

AGGREGATION_UNSPECIFIED: Unspecified.
AGGREGATION_MIN: Minimum.
AGGREGATION_MAX: Maximum.
AGGREGATION_AVG: Average.
AGGREGATION_MEDIAN: Median.
AGGREGATION_STD_DEV: Standard deviation.

ProtocolCodesAbsolute

Field

Description

codesPatterns[]

string

Protocol (HTTP, GRPC) code patterns to match.

All successful HTTP responses: ['2xx', '3xx'].
All failed HTTP responses: ['0', '4xx', '5xx'].

ProtocolCodesRelative

Field

Description

codesPatterns[]

string

Protocol (HTTP, GRPC) code patterns to match.

All successful HTTP responses: ['2xx', '3xx'].
All failed HTTP responses: ['0', '4xx', '5xx'].

NetworkCodesAbsolute

Field

Description

codesPatterns[]

string

Network code patterns to match.

All successful network responses: ['0'].
All failed network responses: ['xx', 'xxx'].

NetworkCodesRelative

Field

Description

codesPatterns[]

string

Network code patterns to match.

All successful network responses: ['0'].
All failed network responses: ['xx', 'xxx'].

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

COMPARISON_UNSPECIFIED: Unspecified.
COMPARISON_LT: Less than the specified value.
COMPARISON_LTE: Less than or equal to the specified value.
COMPARISON_GT: Greater than the specified value.
COMPARISON_GTE: Greater than or equal to the specified value.

TextWidget

Text widget.

Field

Description

text

string

Text string.

TitleWidget

Title widget.

Field

Description

text

string

Title string.

size

enum (TitleSize)

Title size.

TITLE_SIZE_UNSPECIFIED: Unspecified.
TITLE_SIZE_XS: Extra small.
TITLE_SIZE_S: Small.
TITLE_SIZE_M: Medium.
TITLE_SIZE_L: Large.

Load Testing API, REST: RegressionDashboard.Update

HTTP requestHTTP request

Path parametersPath parameters

Body parametersBody parameters

ContentContent

WidgetWidget

LayoutPositionLayoutPosition

ChartWidgetChartWidget

KpiKpi

KpiSelectorKpiSelector

ResponseTimeResponseTime

InstancesInstances

ProtocolCodesAbsoluteProtocolCodesAbsolute

ProtocolCodesRelativeProtocolCodesRelative

NetworkCodesAbsoluteNetworkCodesAbsolute

NetworkCodesRelativeNetworkCodesRelative

KpiThresholdKpiThreshold

TextWidgetTextWidget

TitleWidgetTitleWidget

ResponseResponse

UpdateRegressionDashboardMetadataUpdateRegressionDashboardMetadata

StatusStatus

DashboardDashboard

ContentContent

WidgetWidget

LayoutPositionLayoutPosition

ChartWidgetChartWidget

KpiKpi

KpiSelectorKpiSelector

ResponseTimeResponseTime

InstancesInstances

ProtocolCodesAbsoluteProtocolCodesAbsolute

ProtocolCodesRelativeProtocolCodesRelative

NetworkCodesAbsoluteNetworkCodesAbsolute

NetworkCodesRelativeNetworkCodesRelative

KpiThresholdKpiThreshold

TextWidgetTextWidget

TitleWidgetTitleWidget

Was the article helpful?

HTTP request

Path parameters

Body parameters

Content

Widget

LayoutPosition

ChartWidget

Kpi

KpiSelector

ResponseTime

Instances

ProtocolCodesAbsolute

ProtocolCodesRelative

NetworkCodesAbsolute

NetworkCodesRelative

KpiThreshold

TextWidget

TitleWidget

Response

UpdateRegressionDashboardMetadata

Status

Dashboard

Content

Widget

LayoutPosition

ChartWidget

Kpi

KpiSelector

ResponseTime

Instances

ProtocolCodesAbsolute

ProtocolCodesRelative

NetworkCodesAbsolute

NetworkCodesRelative

KpiThreshold

TextWidget

TitleWidget