Metric units API - GET convert units
Converts a source unit into a target unit.
If no target unit is set, the request finds an appropriate target unit automatically, taking into account the preferred number format (if specified).
The request produces an application/json payload.
| GET | Managed | https://{your-domain}/e/{your-environment-id}/api/v2/units/{unitId}/convert |
| SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/units/{unitId}/convert | |
| Environment ActiveGate | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/units/{unitId}/convert |
Authentication
To execute this request, you need an access token with Read metrics (metrics.read) scope. To learn how to obtain and use it, see Tokens and authentication.
Parameters
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| unitId | string | The ID of the source unit. | path | required |
| value | number | The value to be converted. | query | required |
| targetUnit | string | The ID of the target unit. | query | optional |
| numberFormat | string | The preferred number format. Only taken into account if no target unit is specified. | query | optional |
Response
Response codes
| Code | Type | Description |
|---|---|---|
| 200 | Unit | Success |
| 404 | - | Not found. The requested resource is not found or the query is incorrect. |
Response body objects
The UnitConversionResult object
The result of a unit conversion.
| Element | Type | Description |
|---|---|---|
| unitId | string | The ID of the unit of this conversion result. |
| resultValue | number | The result of the unit conversion. |
Response body JSON model
{
"unitId": "string",
"resultValue": 1
}