Timeseries API - GET data points

Fetches parameters and data points of the specified metric.

To obtain data points, set the includeData parameter to true. You must also specify the timeframe and the aggregation type supported by the requested metric. See the Parameters section for more details.

You can obtain either data points or the scalar result of the specified metric, depending on the queryMode.

The request produces an application/json payload.

GET	Managed https://{your-domain}/e/{your-environment-id}/api/v1/timeseries/{timeseriesIdentifier} SaaS https://{your-environment-id}.live.dexp.ae/api/v1/timeseries/{timeseriesIdentifier}

Authentication

To execute this request, you need the Access problem and event feed, metrics, and topology permission assigned to your API token. See the Authentication page to learn how to obtain and use it.

Parameters

To obtain data points, you must specify the timeframe and the aggregation type.

There are two mutually exclusive ways to set timeframe:

Combination of startTimestamp and endTimestamp.
relativeTime

The maximum allowed timeframe is 6 months.

Parameter	Type	Description	In	Required
timeseriesIdentifier	string	The case-sensitive ID of the timeseries, from which you want to read parameters and data points.	path	required
includeData	boolean	The flag to include data points in the response. Set to `true` to obtain data points. You must also specify the timeframe and aggregation type. Defaults to `false`, meaning data points are not included.	query	optional
aggregationType	string	The aggregation type for the resulting data points. If the requested metric doesn't support the specified aggregation, the request will result in an error. The aggregationType element can hold these values.	query	optional
startTimestamp	integer	The start timestamp of the requested timeframe, in UTC milliseconds.	query	optional
endTimestamp	integer	The end timestamp of the requested timeframe, in milliseconds (UTC). If later than the current time, DESK automatically uses the current time instead. The timeframe must not exceed 6 months.	query	optional
predict	boolean	The flag to predict future data points.	query	optional
relativeTime	string	The relative timeframe, back from the current time. The relativeTime element can hold these values.	query	optional
queryMode	string	The type of result that the call should return. Valid result modes are: `series`: returns all the data points of the timeseries in specified timeframe. `total`: returns one scalar value for the specified timeframe. By default, the `series` mode is used. The queryMode element can hold these values.	query	optional
entity	array	Filters requested data points by the entity that should deliver them. Allowed values are DESK entity IDs. You can specify several entities in the following format: `entity=entity1&entity=entity2`. The entity has to match at least one of the specified IDs. If the selected entity doesn't support the requested timeseries, the request will result in an error.	query	optional
tag	array	Filters requested data points by entity which should deliver them. Only data from entities with the specified tag is delivered. You can specify several tags in the following format: `tag=tag1&tag=tag2`. The entity has to match all the specified tags. In case of key-value tags, such as imported AWS or CloudFoundry tags use the following format: `[context]key:value`.	query	optional
percentile	integer	Specifies which percentile of the selected response time metric should be delivered. Applicable only to the `PERCENTILE` aggregation type. Valid values for percentile are between 1 and 99. Keep in mind that percentile export is possible only for response-time-based metrics such as application and service response times.	query	optional
includeParentIds	boolean	If set to true the result exposes dimension mappings between parent entities and their children. For instance: SERVICE-0000000000000001, SERVICE_METHOD-0000000000000001	query	optional
considerMaintenanceWindowsForAvailability	boolean	Exclude (`true`) or include (`false`) data points from any maintenance window, defined in your environment.	query	optional

Possible values

Possible values for the queryMode element:

SERIES
TOTAL

Possible values for the relativeTime element:

10mins
15mins
2hours
30mins
3days
5mins
6hours
day
hour
min
month
week

Possible values for the aggregationType element:

AVG
COUNT
MAX
MEDIAN
MIN
PERCENTILE
SUM

Response format

The result is a JSON object that contains metric data points and parameters.

Response parameters JSON model

The TimeseriesQueryResult object

The configuration of a metric with all its parameters and, optionally, data points.

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.
unit	string	The unit of the metric.
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.
dataResult	TimeseriesDataPointQueryResult
aggregationTypes	string[]	The list of allowed aggregations for this metric.
filter	string	The feature, where the metric originates.

The TimeseriesDataPointQueryResult object

List of metric's datapoints, as well as their parameters.

Element	Type	Description
dataPoints	object	Data points of a metric. A JSON object that maps the ID of the entity that delivered the data points and an array, which consists of arrays of the data point float values. May contain more than one entity ID per record (for example, a host and its network interface). In such cases, entity IDs are separated by commas. A datapoint contains a value and a timestamp, at which the value was recorded. DESK stores data in time slots. The dataPoints object shows the starting timestamp of the slot. If the startTimestamp or endTimestamp of your query lies inside of the data time slot, this time slot is included into response. Due to the fact that the timestamp of the first data point lies outside of the specified timeframe, you will see earlier timestamp than the specified startTimestamp in the first data point of the response. There are three versions of data points: Numeric datapoint: Contains a numeric value. Enum datapoint: Contains an enum value, currently only for availability timeseries. Prediction datapoint: Similar to the numeric datapoint, but it contains a confidence interval, within which the future values are expected to be.
unit	string	The unit of data points.
resolutionInMillisUTC	integer	The resolution of data points.
aggregationType	string	The type of data points aggregation.
entities	object	The list of entities where the data points originate. A JSON object that maps the entity ID in DESK and the actual name of the entity.
timeseriesId	string	The ID of the metric.

    
{
  "timeseriesId": "com.DESK.builtin:host.cpu.idle",
  "displayName": "CPU idle",
  "dimensions": [
    "HOST"
  ],
  "allowedAggregationTypes": [
    "AVG",
    "SUM",
    "MIN",
    "MAX"
  ],
  "unit": "Percent",
  "configSource": "BUILTIN",
  "detailedSource": "Infrastructure",
  "types": [],
  "dataResult": {
    "dataPoints": {
      "HOST-0000000000000007": [
        [
          1522220334000,
          89
        ]
      ]
    },
    "externalTimeseriesId": "com.DESK.builtin:host.cpu.idle",
    "unit": "Percent",
    "entities": {
      "HOST-0000000000000007": "Laptop-8"
    },
    "resolutionInMillisUTC": 300000,
    "aggregationType": "AVG"
  }
}

Timeframe note

DESK stores data in time slots. The dataPoints object shows the starting timestamp of the slot. If the startTimestamp or endTimestamp of your query fall within the data time slot, this time slot will be included in the response. Due to the fact that the timestamp of the first data point lies outside of the specified timeframe, you will see an earlier timestamp than the specified startTimestamp in the first data point of the response.

Timestamp scheme

Example

In this example, the request returns values of the Actions per session (com.DESK.builtin:app.actionspersession) metric within the last hour for the APPLICATION-85A7CC and APPLICATION-8E41C8 applications.

The API token is passed in the Authorization header.

The result returns the average number of user actions per application, truncated to three data points per application.

Curl

curl -X GET \
  https://mySampleEnv.live.dexp.ae/api/v1/timeseries/com.DESK.builtin:app.actionspersession?includeData=true&relativeTime=hour&aggregationType=avg&entity=APPLICATION-85A7CC&entity=APPLICATION-8E41C8 \
  -H 'Authorization: Api-Token abcdefjhij1234567890'

Request URL

https://mySampleEnv.live.dexp.ae/api/v1/timeseries/com.DESK.builtin:app.actionspersession?includeData=true&relativeTime=hour&aggregationType=avg&entity=APPLICATION-85A7CC&entity=APPLICATION-8E41C8

Response content

{
  "timeseriesId": "com.DESK.builtin:app.actionspersession",
  "displayName": "Actions per session",
  "dimensions": [
    "APPLICATION"
  ],
  "unit": "PerMinute (count/min)",
  "detailedSource": "Web application",
  "types": [],
  "dataResult": {
    "dataPoints": {
      "APPLICATION-85A7CC": [
        [
          1534921560000,
          1.75
        ],
        [
          1534921620000,
          2
        ],
        [
          1534921680000,
          2
        ]
      ],
      "APPLICATION-8E41C8": [
        [
          1534921560000,
          4
        ],
        [
          1534921620000,
          7
        ],
        [
          1534921680000,
          4
        ]
      ]
    },
    "unit": "PerMinute (count/min)",
    "resolutionInMillisUTC": 60000,
    "aggregationType": "AVG",
    "entities": {
      "APPLICATION-85A7CC": "Permanent Docker",
      "APPLICATION-8E41C8": "easyTravel AMP"
    },
    "timeseriesId": "com.DESK.builtin:app.actionspersession"
  },
  "aggregationTypes": [
    "AVG"
  ],
  "filter": "BUILTIN"
}

Response code

200