Timeseries API - POST data points

Fetches parameters and data points of the specified metric. In comparison to a GET request, a POST request provides less data about the metric itself.

To obtain data points, you must specify the timeframe and the aggregation type supported by the requested metric. See the Parameters section for more details.

The request consumes and produces an application/json payload.

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.

      
  {
  "timeseriesId": "com.DESK.builtin:host.cpu.idle",
  "aggregationType": "AVG",
  "startTimestamp": 1521042929000,
  "endTimestamp": 1521542929000,
  "predict": true,
  "relativeTime": "HOUR",
  "queryMode": "SERIES",
  "includeParentIds": "false",
  "considerMaintenanceWindowsForAvailability": "false",
  "entities": [
    "HOST-0000000000000007"
  ],
  "tags": [
    "office-linz"
  ]
}
      
    

Possible values

Response format

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

    
{
  "result": {
    "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.

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 result returns the average numbers of user actions per application. The result is truncated to three data points per application.

Curl

curl -X POST \
  https://mySampleEnv.live.dexp.ae/api/v1/timeseries \
  -H 'Authorization: abcdefjhij1234567890' \  
  -H 'Content-Type: application/json' \  
  -d '{
  "timeseriesId": "com.DESK.builtin:app.actionspersession",
  "relativeTime": "hour",
  "aggregationType": "avg",
  "entities": [
  	"APPLICATION-85A7CCAAC7345F0B",
  	"APPLICATION-8E41C8C247910758"
  	]
}'

Request URL

https://mySampleEnv.live.dexp.ae/api/v1/timeseries

Request body

{
  "timeseriesId": "com.DESK.builtin:app.actionspersession",
  "relativeTime": "hour",
  "aggregationType": "avg",
  "entities": [
    "APPLICATION-85A7CC",
    "APPLICATION-8E41C8"
  ]
}

Response content

{
  "result": {
    "dataPoints": {
      "APPLICATION-85A7CC": [
        [
          1534920000000,
          1.6666666666666667
        ],
        [
          1534920060000,
          2.5
        ],
        [
          1534920120000,
          2.888888888888889
        ]
      ],
      "APPLICATION-8E41C8": [
        [
          1534920000000,
          null
        ],
        [
          1534920060000,
          3
        ],
        [
          1534920120000,
          null
        ]
      ]
    },
    "unit": "PerMinute (count/min)",
    "resolutionInMillisUTC": 60000,
    "aggregationType": "AVG",
    "entities": {
      "APPLICATION-85A7CC": "Permanent Docker",
      "APPLICATION-8E41C8": "easyTravel AMP"
    },
    "timeseriesId": "com.DESK.builtin:app.actionspersession"
  }
}

Response code

200