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 Access problem and event feed, metrics, and topology (DataExport) permission assigned to your API token. 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. | 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 | Timeseries | Success |
Response body objects
The TimeseriesDefinition object
The configuration of a metric with all its parameters.
| Element | Type | Description | Required |
|---|---|---|---|
| timeseriesId | string | The ID of the metric. | optional |
| displayName | string | The name of the metric in the user interface. | optional |
| dimensions | string[] | The fine metric division, for example process group and process ID for some process-related metric. | optional |
| aggregationTypes | string[] | The list of allowed aggregations for this metric. | optional |
| unit | string | The unit of the metric. | optional |
| filter | string | The feature, where the metric originates. | optional |
| detailedSource | string | The feature, where the metric originates. | optional |
| pluginId | string | The ID of the plugin, where the metric originates. | optional |
| types | string[] | Technology type definition. Used to group metrics under a logical technology name. | optional |
| warnings | string[] | The warnings that occurred while creating the metric. | optional |
Response body JSON model
[
{
"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
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
https://mySampleEnv.live.dynatrace.com/api/v1/timeseries?api-token&source=plugin&detailedsource=PHP-FPMResponse content
[
{
"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.
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.