Timeseries API v1 - GET list of metrics

We have a new version of this API—Metrics API v2. Check it out!

Lists all metric definitions, along with parameters of each metric available within your environment.

The full list can be lengthy, but you can narrow it down by specifying filter parameters such as the source of the metric. See the Parameters expandable section for more details.

The request produces an application/json payload.

GET	Managed	`https://{your-domain}/e/{your-environment-id}/api/v1/timeseries`
	SaaS	`https://{your-environment-id}.live.dynatrace.com/api/v1/timeseries`
	Environment ActiveGate	`https://{your-activegate-domain}/e/{your-environment-id}/api/v1/timeseries`

Authentication

To execute this request, you need an access token with Access problem and event feed, metrics, and topology (DataExport) scope. To learn how to obtain and use it, see Tokens and authentication.

Parameters

Parameter	Type	Description	In	Required
source	string	The type of the metric, such as BUILTIN or CUSTOM. The element can hold these values `ALL` `BUILTIN` `CUSTOM` `PLUGIN` `REMOTE_PLUGIN`	query	optional
detailedSource	string	The feature where metrics originates, such as Synthetic or RUM.	query	optional

Possible values for the `detailedSource` element:

You can find allowed values for the detailedSource element in the subheadings of the Built-in metrics and Plugin metrics sections of the available metrics pages for SaaS and Managed. Use them exactly as in headings—spaces included.

Response

The result is JSON containing the array of objects, with each object representing a metric.

Response codes

Code	Type	Description
200	TimeseriesDefinition[]	Success

Response body objects

The `ResponseBody` object

The object doesn't provide any parameters.

The `TimeseriesDefinition` object

The configuration of a metric with all its parameters.

Element	Type	Description
timeseriesId	string	The ID of the metric.
displayName	string	The name of the metric in the user interface.
dimensions	string[]	The fine metric division, for example process group and process ID for some process-related metric.
aggregationTypes	string[]	The list of allowed aggregations for this metric. The element can hold these values `AVG` `COUNT` `MAX` `MEDIAN` `MIN` `PERCENTILE` `SUM`
unit	string	The unit of the metric. The element can hold these values `Billion (bilcount)` `Bit (bit)` `BitPerHour (bit/h)` `BitPerMinute (bit/min)` `BitPerSecond (bit/s)` `Byte (B)` `BytePerHour (B/h)` `BytePerMinute (B/min)` `BytePerSecond (B/s)` `Cores` `Count (count)` `Day (ds)` `DecibelMilliWatt (dBm)` `G` `GibiByte (GiB)` `GigaByte (GB)` `Hour (hs)` `KibiByte (KiB)` `KibiBytePerHour (KiB/h)` `KibiBytePerMinute (KiB/min)` `KibiBytePerSecond (KiB/s)` `KiloByte (kB)` `KiloBytePerHour (kB/h)` `KiloBytePerMinute (kB/min)` `KiloBytePerSecond (kB/s)` `M` `MSU` `MebiByte (MiB)` `MebiBytePerHour (MiB/h)` `MebiBytePerMinute (MiB/min)` `MebiBytePerSecond (MiB/s)` `MegaByte (MB)` `MegaBytePerHour (MB/h)` `MegaBytePerMinute (MB/min)` `MegaBytePerSecond (MB/s)` `MicroSecond (µs)` `MilliSecond (ms)` `MilliSecondPerMinute (ms/min)` `Million (milcount)` `Minute (mins)` `Month (mos)` `N/A` `NanoSecond (ns)` `NanoSecondPerMinute (ns/min)` `PerHour (count/h)` `PerMinute (count/min)` `PerSecond (count/s)` `Percent (%)` `Pixel (px)` `Promille (‰)` `Ratio` `Second (s)` `State` `Unspecified` `Week (ws)` `Year (ys)` `k` `mCores`
filter	string	The feature, where the metric originates. The element can hold these values `ALL` `BUILTIN` `CUSTOM` `PLUGIN` `REMOTE_PLUGIN`
detailedSource	string	The feature, where the metric originates.
pluginId	string	The ID of the plugin, where the metric originates.
types	string[]	Technology type definition. Used to group metrics under a logical technology name.
warnings	string[]	The warnings that occurred while creating the metric.

Response body JSON model

json
[
  {
    "timeseriesId": "com.dynatrace.builting:host.cpu.idle",
    "displayName": "CPU idle",
    "dimensions": [
      "HOST"
    ],
    "aggregationTypes": [
      "AVG",
      "SUM",
      "MIN",
      "MAX"
    ],
    "unit": "Percent",
    "filter": "BUILTIN",
    "detailedSource": "Infrastructure",
    "types": [
      "Test"
    ],
    "warnings": []
  }
]

Example

In this example, the request lists the metric of the PLUGIN type, where the detailed source is PHP-FPM.

The API token is passed in the Authorization header.

The result is truncated to two entries.

Curl

bash
curl -X GET \
  'https://mySampleEnv.live.dynatrace.com/api/v1/timeseries?source=plugin&detailedsource=PHP-FPM' \
  -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

Request URL

plaintext
https://mySampleEnv.live.dynatrace.com/api/v1/timeseries?api-token&source=plugin&detailedsource=PHP-FPM

Response content

json
[
  {
    "timeseriesId": "beta.python.phpfpm.dev:accepted conn",
    "displayName": "accepted conn",
    "dimensions": [
      "PROCESS_GROUP_INSTANCE",
      "pool"
    ],
    "aggregationTypes": [
      "AVG",
      "SUM",
      "MIN",
      "MAX"
    ],
    "unit": "Count (count)",
    "filter": "PLUGIN",
    "detailedSource": "PHP-FPM",
    "pluginId": "beta.python.phpfpm.dev",
    "types": []
   },
   {
     "timeseriesId": "beta.python.phpfpm.dev:active processes",
     "displayName": "active processes",
     "dimensions": [
       "PROCESS_GROUP_INSTANCE",
       "pool"
     ],
    "aggregationTypes": [
      "AVG",
      "SUM",
      "MIN",
      "MAX"
    ],
    "unit": "Count (count)",
    "filter": "PLUGIN",
    "detailedSource": "PHP-FPM",
    "pluginId": "beta.python.phpfpm.dev",
    "types": []
  }
]

Response code

200

Process types

The list of known process types we monitor with Dynatrace is continuously growing. If you don't see the process type you want in the list below, please refer to the Dynatrace processes page to see whether the process is included there.

Click to view process types list

apachehttp
apmng
awsrds
cassandra
couchdb
db2
dockerdaemon
dotnet
erlang
glassfish

haproxy
iis
iisapppool
java
jboss
linuxsystem
memcached
mongodb
mongodbrouter

mssql
mysql
nginx
nodejs
oracledb
perl
php
postgres
python

redis
ruby
tomcat
unknown
varnishcache
weblogic
websphere
windowsservice
windowssystem

OS types

The list of known operating systems that we monitor with Dynatrace is continuously growing. If you don't see the OS type you want listed below, please refer to the Dynatrace hosts page to see whether the OS type is included there.

Click to view the OS list

aix
darwin
hpux
linux

solaris
unknown
windows
zos

Service types

Click to view the services list

database
messaging
method
mobile
process

rmi
unknown
webrequest
webservice
website

Technology types

Click to view the technology list

apache
dotnet
iis
java
loganalytics
net
nginx
nodejs

os
php
ruby
sdk
unknown
varnish
wsmb
z

Aggregation types

Click to view aggregation type list

max
min
sum
count

avg
median
percentile

Timeseries API v1 - GET list of metrics

Authentication

Parameters

Possible values for the detailedSource element:

Response

Response codes

Response body objects

The ResponseBody object

The TimeseriesDefinition object

Response body JSON model

Example

Curl

Request URL

Response content

Response code

Process types

OS types

Service types

Technology types

Aggregation types

Possible values for the `detailedSource` element:

The `ResponseBody` object

The `TimeseriesDefinition` object