Timeseries API - GET list of metrics

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.

Parameters

Possible values

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 format

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

    
[
  {
    "timeseriesId": "com.DESK.builting:host.cpu.idle",
    "displayName": "CPU idle",
    "dimensions": [
      "HOST"
    ],
    "allowedAggregationTypes": [
      "AVG",
      "SUM",
      "MIN",
      "MAX"
    ],
    "unit": "Percent",
    "configSource": "BUILTIN",
    "detailedSource": "Infrastructure",
    "types": [
      "Test"
    ]
  }
]
    
  

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.dexp.ae/api/v1/timeseries?source=plugin&detailedsource=PHP-FPM' \
  -H 'Authorization: Api-Token abcdefjhij1234567890'

Request URL

https://mySampleEnv.live.dexp.ae/api/v1/timeseries?api-token&source=plugin&detailedsource=PHP-FPM

Response 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 DESK is continuously growing. If you don't see the process type you want in the list below, please refer to the DESK processes page to see whether the process is included there.

OS types

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

Service types

Technology types

Aggregation types