Synthetic metrics API - GET a metric

Gets the descriptor of the specified calculated synthetic metric.

The request produces an application/json payload.

GET	ManagedDynatrace for Government	`https://{your-domain}/e/{your-environment-id}/api/config/v1/calculatedMetrics/synthetic/{metricKey}`
	SaaS	`https://{your-environment-id}.live.dynatrace.com/api/config/v1/calculatedMetrics/synthetic/{metricKey}`
	Environment ActiveGate	`https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/calculatedMetrics/synthetic/{metricKey}`

Authentication

To execute this request, you need an access token with ReadConfig scope.

To learn how to obtain and use it, see Tokens and authentication.

Parameters

Parameter	Type	Description	In	Required
metricKey	string	The key of the required calculated synthetic metric.	path	required

Response

Response codes

Code	Type	Description
200	CalculatedSyntheticMetric	Success

Response body objects

The `CalculatedSyntheticMetric` object

Definition of the calculated synthetic metric.

Element	Type	Description
monitorIdentifier	string	The Dynatrace entity ID of the synthetic monitor to which the metric belongs.
name	string	The name of the metric, displayed in the UI.
metricKey	string	The unique key of the metric. The key must have the `calc:synthetic` prefix.
enabled	boolean	The metric is enabled (`true`) or disabled (`false`).
metric	string	The type of the synthetic metric. The element can hold these values `ApplicationCache` `Callback` `CumulativeLayoutShift` `DNSLookup` `DOMComplete` `DOMContentLoaded` `DOMInteractive` `FailedRequestsResources` `FirstContentfulPaint` `FirstInputDelay` `FirstInputStart` `FirstPaint` `HTMLDownloaded` `HttpErrors` `JavaScriptErrors` `LargestContentfulPaint` `LoadEventEnd` `LoadEventStart` `LongTasks` `NavigationStart` `OnDOMContentLoaded` `OnLoad` `Processing` `RedirectTime` `Request` `RequestStart` `ResourceCount` `Response` `SecureConnect` `SpeedIndex` `TCPConnect` `TimeToFirstByte` `TotalDuration` `TransferSize` `UserActionDuration` `VisuallyComplete`
dimensions	SyntheticMetricDimension[]	A list of metric dimensions.
filter	SyntheticMetricFilter	Filter of the calculated synthetic metric.

The `SyntheticMetricDimension` object

Dimension of the calculated synthetic metric.

Element	Type	Description
topX	integer	The number of top values to be calculated.
dimension	string	The dimension of the metric. The element can hold these values `Event` `Location` `ResourceOrigin`

The `SyntheticMetricFilter` object

Filter of the calculated synthetic metric.

Element	Type	Description
actionType	string	Only user actions of the specified type are included in the metric calculation. The element can hold these values `Custom` `Load` `Xhr`
hasError	boolean	The execution status of the monitors to be included in the metric calculation: `true`: Only failed executions are included. `false`: All executions are included.
errorCode	integer	Only executions finished with the specified error code are included in the metric calculation.
event	string	Only the specified browser clickpath event is included in the metric calculation. Specify the Dynatrace entity ID of the event here. You can fetch the list of clickpath events of the monitor with the GET a synthetic monitor request from the Environment API
location	string	Only executions from the specified location are included in the metric calculation. Specify the Dynatrace entity ID of the location here. You can fetch the list of locations the monitor is running from with the GET a synthetic monitor request from the Environment API.

Response body JSON model

json
{
  "enabled": true,
  "name": "MyMetric",
  "metricKey": "calc:synthetic.browser.mymetric",
  "metric": "UserActionDuration",
  "monitorIdentifier": "SYNTHETIC_TEST-1234",
  "filter": {
    "event": "SYNTHETIC_TEST_STEP-1234",
    "hasError": true
  },
  "dimensions": [
    {
      "dimension": "Location"
    }
  ]
}