Lists all available metric units of your environment.
The request produces an application/json
payload.
GET | SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/units |
Environment ActiveGateCluster ActiveGate | https://{your-activegate-domain}:9999/e/{your-environment-id}/api/v2/units |
To execute this request, you need an access token with metrics.read
scope.
To learn how to obtain and use it, see Tokens and authentication.
Parameter | Type | Description | In | Required |
---|---|---|---|---|
unitSelector | string | Selects units to be included to the response. Available criteria:
| query | optional |
fields | string | Defines the list of properties to be included in the response. The ID of the unit is always included. The following additional properties are available:
By default, the ID, the display name, and the symbol are included. To add properties, list them with leading plus To specify several properties, join them with a comma (for example If you specify just one property, the response contains the unitId and the specified property. To return unit IDs only, specify | query | optional |
Code | Type | Description |
---|---|---|
200 | Unit | Success |
4XX | Error | Client side error. |
5XX | Error | Server side error. |
UnitList
objectA list of units along with their properties.
Element | Type | Description |
---|---|---|
totalCount | integer | The total number of units in the result. |
units | Unit[] | A list of units. |
Unit
objectThe metadata of a unit.
Element | Type | Description |
---|---|---|
description | string | A short description of the unit. |
displayName | string | The display name of the unit. |
displayNamePlural | string | The plural display name of the unit. |
symbol | string | The symbol of the unit. |
unitId | string | The ID of the unit. |
{"totalCount": 2,"units": [{"description": "byte per second","displayName": "byte per second","displayNamePlural": "bytes per second","symbol": "B/s","unitId": "BytePerSecond"},{"description": "byte per minute","displayName": "byte per minute","displayNamePlural": "bytes per minute","symbol": "B/min","unitId": "BytePerMinute"}]}
In this example, the request lists all metric units available for the mySampleEnv environment.
The API token is passed in the Authorization header.
The result is truncated to three entries.
curl --request GET \--url https://mySampleEnv.live.dynatrace.com/api/v2/units \--header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'
https://mySampleEnv.live.dynatrace.com/api/v2/units
{"totalCount": 3,"activeGateTokens": [{"unitId": "Second","displayName": "second","symbol": "s"},{"unitId": "GigaBit","displayName": "gigabit","symbol": "Gbit"},{"unitId": "KiloBytePerSecond","displayName": "kilobyte per second","symbol": "kB/s"}]}
200