Web application metrics API - PUT a metric
Updates the descriptor of the specified calculated web application metric.
The request consumes and produces an application/json payload.
| PUT |
|
Authentication
To execute this request, you need the Write configuration (WriteConfig) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.
Parameters
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| metricKey | string |
The key of the calculated web application metric to be updated. |
path | required |
| body |
Web |
The JSON body of the request. Contains the updated parameters of the calculated web application metric. |
body | optional |
Body format
The WebApplicationMetricUpdate object
The update of the calculated web application metric.
| Element | Type | Description | Required |
|---|---|---|---|
| enabled | boolean |
The metric is enabled ( |
optional |
This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request. See the Example expandable section for working sample request.
{
"enabled": true
}
Response
Response codes
| Code | Description |
|---|---|
| 204 | Success. The metric has been updated. Response doesn't have a body. |
| 400 | Failed. The input is invalid. |
Response body
A successful request doesn't return any content.
Validate payload
We recommend that you validate the payload before submitting it with an actual request. A response code of 204 indicates a valid payload.
The request consumes an application/json payload.
| POST |
|
Authentication
To execute this request, you need the Write configuration (WriteConfig) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.
Response
Response codes
| Code | Description |
|---|---|
| 204 | Validated. The submitted metric is valid. The response doesn't have a body. |
| 400 | Failed. The input is invalid. |
Response body
A successful request doesn't return any content.