Settings API - Custom units schema table

  • Published Dec 05, 2023

Custom units (builtin:custom-unit)

Here you can create custom units.

Schema IDSchema groupsScope
builtin:custom-unit
  • group:metrics
environment
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:custom-unit
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:custom-unit
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:custom-unit

Authentication

To execute this request, you need an access token with Read settings (settings.read) scope. To learn how to obtain and use it, see Tokens and authentication.

Parameters

PropertyTypeDescriptionRequired
Unit name
newUnitName		text

Unit name has to be unique and is used as identifier.

E.g: Byte, Second, BytePerMinute

required
Unit plural name
newUnitPluralName		text

Unit plural name represent the plural form of the unit name.

E.g: Bytes, Seconds

required
Unit symbol
newUnitSymbol		text

Unit symbol has to be unique.

E.g: s, m/s, B/min, bit/s

required
Unit description
newUnitDescription		text

Unit description should provide additional information about the new unit

E.g: Byte: 8 bits of information

required