Load Testing API, REST: RegressionDashboard.list
Retrieves the list of regression dashboards in the specified folder.
HTTP request
GET https://loadtesting.api.cloud.yandex.net/loadtesting/api/v1/regressionDashboards
Query parameters
Parameter | Description |
---|---|
folderId | Required. ID of the folder to list dashboards in. The maximum string length in characters is 50. |
pageSize | The maximum number of results per page to return. If the number of available results is larger than The maximum value is 1000. |
pageToken | Page token. To get the next page of results, set The maximum string length in characters is 100. |
filter | A filter expression that filters dashboards listed in the response. The filter expression may contain multiple field expressions joined by
Currently supported fields:
Examples:
The maximum string length in characters is 1000. |
Response
HTTP Code: 200 - OK
{
"dashboards": [
{
"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"
},
// `dashboards[].content.widgets[]` includes only one of the fields `chart`, `text`, `title`
"chart": {
"id": "string",
"name": "string",
"description": "string",
"filterStr": "string",
"testCase": "string",
"kpis": [
{
"selector": {
// `dashboards[].content.widgets[].chart.kpis[].selector` includes only one of the fields `responseTime`, `instances`, `imbalanceRps`, `protocolCodesAbsolute`, `protocolCodesRelative`, `networkCodesAbsolute`, `networkCodesRelative`
"responseTime": {
"quantile": "string"
},
"instances": {
"agg": "string"
},
"imbalanceRps": {},
"protocolCodesAbsolute": {
"codesPatterns": [
"string"
]
},
"protocolCodesRelative": {
"codesPatterns": [
"string"
]
},
"networkCodesAbsolute": {
"codesPatterns": [
"string"
]
},
"networkCodesRelative": {
"codesPatterns": [
"string"
]
},
// end of the list of possible fields`dashboards[].content.widgets[].chart.kpis[].selector`
},
"threshold": {
"value": "number",
"comparison": "string"
}
}
]
},
"text": {
"text": "string"
},
"title": {
"text": "string",
"size": "string"
},
// end of the list of possible fields`dashboards[].content.widgets[]`
}
]
}
}
],
"nextPageToken": "string"
}
Field | Description |
---|---|
dashboards[] | object List of dashboards in the specified folder. |
dashboards[]. id |
string ID of the dashboard. |
dashboards[]. name |
string Name of the dashboard. |
dashboards[]. description |
string Description of the dashboard. |
dashboards[]. 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 Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
dashboards[]. 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 Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
dashboards[]. createdBy |
string UA or SA that created the dashboard. |
dashboards[]. updatedBy |
string UA or SA that updated the dashboard last time. |
dashboards[]. etag |
string Etag of the dashboard. |
dashboards[]. content |
object Dashboard content. Content of regression dashboard. |
dashboards[]. content. widgets[] |
object Widgets. |
dashboards[]. content. widgets[]. position |
object Widget position. |
dashboards[]. content. widgets[]. position. x |
string (int64) X. |
dashboards[]. content. widgets[]. position. y |
string (int64) Y. |
dashboards[]. content. widgets[]. position. width |
string (int64) Width. |
dashboards[]. content. widgets[]. position. height |
string (int64) Height. |
dashboards[]. content. widgets[]. chart |
object Chart widget. dashboards[].content.widgets[] includes only one of the fields chart , text , title |
dashboards[]. content. widgets[]. chart. id |
string ID of the chart. |
dashboards[]. content. widgets[]. chart. name |
string Name of the chart. |
dashboards[]. content. widgets[]. chart. description |
string Description of the chart. |
dashboards[]. content. widgets[]. chart. filterStr |
string Test filter selector to show KPI values for. |
dashboards[]. content. widgets[]. chart. testCase |
string Test case to show KPI values for. |
dashboards[]. content. widgets[]. chart. kpis[] |
object KPIs to show. |
dashboards[]. content. widgets[]. chart. kpis[]. selector |
object Kind of KPI. KPI selector. |
dashboards[]. content. widgets[]. chart. kpis[]. selector. responseTime |
object Response time cummulative quantile (percentile). dashboards[].content.widgets[].chart.kpis[].selector includes only one of the fields responseTime , instances , imbalanceRps , protocolCodesAbsolute , protocolCodesRelative , networkCodesAbsolute , networkCodesRelative |
dashboards[]. content. widgets[]. chart. kpis[]. selector. responseTime. quantile |
string Cummulative quantile (percentile). Quantiles (percentiles).
|
dashboards[]. content. widgets[]. chart. kpis[]. selector. instances |
object A number of instances throughout the test. dashboards[].content.widgets[].chart.kpis[].selector includes only one of the fields responseTime , instances , imbalanceRps , protocolCodesAbsolute , protocolCodesRelative , networkCodesAbsolute , networkCodesRelative |
dashboards[]. content. widgets[]. chart. kpis[]. selector. instances. agg |
string Aggregation function. Aggregation function.
|
dashboards[]. content. widgets[]. chart. kpis[]. selector. imbalanceRps |
object An RPS at the moment the test has been auto-stopped. dashboards[].content.widgets[].chart.kpis[].selector includes only one of the fields responseTime , instances , imbalanceRps , protocolCodesAbsolute , protocolCodesRelative , networkCodesAbsolute , networkCodesRelative |
dashboards[]. content. widgets[]. chart. kpis[]. selector. protocolCodesAbsolute |
object A total number of requests completed with certain protocol (HTTP, GRPC, etc.) codes. dashboards[].content.widgets[].chart.kpis[].selector includes only one of the fields responseTime , instances , imbalanceRps , protocolCodesAbsolute , protocolCodesRelative , networkCodesAbsolute , networkCodesRelative |
dashboards[]. content. widgets[]. chart. kpis[]. selector. protocolCodesAbsolute. codesPatterns[] |
string Protocol (HTTP, GRPC) code patterns to match. All successful HTTP responses: ['2xx', '3xx']. All failed HTTP responses: ['0', '4xx', '5xx']. |
dashboards[]. content. widgets[]. chart. kpis[]. selector. protocolCodesRelative |
object A percentage of requests completed with certain protocol (HTTP, GRPC, etc.) codes. dashboards[].content.widgets[].chart.kpis[].selector includes only one of the fields responseTime , instances , imbalanceRps , protocolCodesAbsolute , protocolCodesRelative , networkCodesAbsolute , networkCodesRelative |
dashboards[]. content. widgets[]. chart. kpis[]. selector. protocolCodesRelative. codesPatterns[] |
string Protocol (HTTP, GRPC) code patterns to match. All successful HTTP responses: ['2xx', '3xx']. All failed HTTP responses: ['0', '4xx', '5xx']. |
dashboards[]. content. widgets[]. chart. kpis[]. selector. networkCodesAbsolute |
object A total number of requests completed with certain network codes. dashboards[].content.widgets[].chart.kpis[].selector includes only one of the fields responseTime , instances , imbalanceRps , protocolCodesAbsolute , protocolCodesRelative , networkCodesAbsolute , networkCodesRelative |
dashboards[]. content. widgets[]. chart. kpis[]. selector. networkCodesAbsolute. codesPatterns[] |
string Network code patterns to match. All successful network responses: ['0']. All failed network responses: ['xx', 'xxx']. |
dashboards[]. content. widgets[]. chart. kpis[]. selector. networkCodesRelative |
object A percentage of requests completed with certain network codes. dashboards[].content.widgets[].chart.kpis[].selector includes only one of the fields responseTime , instances , imbalanceRps , protocolCodesAbsolute , protocolCodesRelative , networkCodesAbsolute , networkCodesRelative |
dashboards[]. content. widgets[]. chart. kpis[]. selector. networkCodesRelative. codesPatterns[] |
string Network code patterns to match. All successful network responses: ['0']. All failed network responses: ['xx', 'xxx']. |
dashboards[]. content. widgets[]. chart. kpis[]. threshold |
object A condition that should be specified. KPI threshold represents a condition that an actual value of test's KPI should satisfy. |
dashboards[]. content. widgets[]. chart. kpis[]. threshold. value |
number (double) Value for comparison with an actual KPI value. |
dashboards[]. content. widgets[]. chart. kpis[]. threshold. comparison |
string Comparison operator for comparing actual with the threshold value. Rule: actual (</<=/>/>=) reference Comparison operator.
|
dashboards[]. content. widgets[]. text |
object Text widget. dashboards[].content.widgets[] includes only one of the fields chart , text , title |
dashboards[]. content. widgets[]. text. text |
string dashboards[].content.widgets[] includes only one of the fields chart , text , title Text string. |
dashboards[]. content. widgets[]. title |
object Title widget. dashboards[].content.widgets[] includes only one of the fields chart , text , title |
dashboards[]. content. widgets[]. title. text |
string dashboards[].content.widgets[] includes only one of the fields chart , text , title Title string. |
dashboards[]. content. widgets[]. title. size |
string Title size. Title size.
|
nextPageToken | string Token for getting the next page of the list. If the number of results is greater than the specified pageSize, use Each subsequent page will have its own The maximum string length in characters is 100. |