Service metrics API - GET metrics on Grail

  • Latest Dynatrace
  • Reference
  • Published Feb 26, 2025

Lists all calculated service metrics enabled on Grail.

The request produces an application/json payload.

GETSaaShttps://{your-environment-id}.live.dynatrace.com/api/config/v1/calculatedMetrics/service/metricsOnGrail
Environment ActiveGatehttps://{your-activegate-domain}:9999/e/{your-environment-id}/api/config/v1/calculatedMetrics/service/metricsOnGrail

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

The request doesn't provide any configurable parameters.

Response

api-path

Response codes

CodeTypeDescription
200StubList

Success

Response body objects

The StubList object

An ordered list of short representations of Dynatrace entities.

ElementTypeDescription
valuesEntityShortRepresentation[]

An ordered list of short representations of Dynatrace entities.

The EntityShortRepresentation object

The short representation of a Dynatrace entity.

ElementTypeDescription
descriptionstring

A short description of the Dynatrace entity.

idstring

The ID of the Dynatrace entity.

namestring

The name of the Dynatrace entity.

Response body JSON models

{
  "values": [
    {
      "description": "Dynatrace entity 1 for the REST API example",
      "id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a",
      "name": "Dynatrace entity 1"
    },
    {
      "id": "ee70f7d3-9a4e-4f5f-94d2-c9d6156f1618",
      "name": "Dynatrace entity 2"
    },
    {
      "id": "8cdabe77-9e1a-4be8-b3df-269dd6fa9d7f"
    }
  ]
}

Example

This is an example listing all calculated service metrics that are enabled on Grail.

The API token is passed in the Authorization header.

Curl

curl -X 'GET' \
  'https://mySampleEnv.live.dynatrace.com/api/config/v1/calculatedMetrics/service/metricsOnGrail' \
  -H 'accept: application/json; charset=utf-8' \
  -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

Request URL

https://mySampleEnv.live.dynatrace.com/api/config/v1/calculatedMetrics/service/metricsOnGrail

Response body

{
  "values": [
    {
      "id": "calc:service.top10queries",
      "name": "top10queries"
    },
    {
      "id": "calc:service.wkndrequestcount",
      "name": "wknd request count"
    },
    {
      "id": "calc:service.aemtoprequests",
      "name": "AEM top 10 requests"
    },
    {
      "id": "calc:service.aemcontentfailurerate",
      "name": "AEM content failure rate"
    },
    {
      "id": "calc:service.csm_on_grail_example_top_10_errors",
      "name": "csm_on_grail_example_top_10_errors"
    }
  ]
}

Response code

200