Time to upgrade! NAM is scheduled for end of support. It's time to move to Dynatrace our all-in-one software intelligence platform.

Alerts API - GET metrics for alert type

Applies to NAM 2019+

Returns metrics available for specified alert type.

GET
  • url https://{console-host}:{console-port}/cxf/api/v1/cxf/api/v1/config/alerts/metrics/{alertType}

Parameters

Parameter Type Description In Required
alertType string

Alert type.

The alertType element can hold these values.
path required
namServer array

Include only metrics available on the specified NAM servers.

query optional
filter string

Include only metrics containing the specified text.

query optional

Possible values

Possible values for the alertType element:

  • METRIC_ALM
  • TRANSMETRIC_ALM
  • TRANSACTIVE_METRIC_ALM
  • GOMEZSTEP_METRIC_ALM
  • GOMEZTEST_METRIC_ALM
  • CITRIXMETRIC_ALM
  • LINK_ALM
  • METRIC_ALM_P2P
  • TIERMETRIC_ALM
  • AMD_DRIVER_ALM
  • AMD_INTERFACE_ALM
  • AMD_SERVER_ALM
  • ESM_METRIC_ALM
  • SYSTEM

Response format

The DmiEntity object

Element Type Description
id string
name string
unit string
dmiType string The dmiType element can hold these values.
alertDataType string The alertDataType element can hold these values.
baselineAvailable boolean
alertType string The alertType element can hold these values.

Possible values

Possible values for the alertType element in the DmiEntity object:

  • METRIC_ALM
  • TRANSMETRIC_ALM
  • TRANSACTIVE_METRIC_ALM
  • GOMEZSTEP_METRIC_ALM
  • GOMEZTEST_METRIC_ALM
  • CITRIXMETRIC_ALM
  • LINK_ALM
  • METRIC_ALM_P2P
  • TIERMETRIC_ALM
  • AMD_DRIVER_ALM
  • AMD_INTERFACE_ALM
  • AMD_SERVER_ALM
  • ESM_METRIC_ALM
  • SYSTEM

Possible values for the alertDataType element in the DmiEntity object:

  • STRING
  • IPADDRESS
  • NUMBER
  • NUMBER_SCALE_10
  • NUMBER_SCALE_100
  • COMPOUND

Possible values for the dmiType element in the DmiEntity object:

  • STRING
  • INT
  • BYTE
  • PKTS
  • BPS
  • MergedBreakdownColumn
  • PERCENT
  • PERIOD_MS
  • NUMBER
  • BREAKDOWN
  • BREAKDOWN_PERC
  • ENUM
  • AutoDiscoveryFlagsRenderer

Response codes

Code Description
default

Metrics available for a given alert type. If no NAM Server is specified, this is the common set of metrics for all available NAM Servers. If one or more NAM Servers are specified as parameters, it is the common set for the specified NAM Servers.