Get the Metrics from a Timeseries Definition

Use this endpoint to request the metrics in a timeseries. A metric is a series of operations that are applied to the timeseries data to produce meaningful insights about the data. Timeseries API supports aggregation, filtering, and arithmetic operations that can run on the timeseries data. Every operation must have input(s) and output(s) and a set of parameters required by that operation. This endpoint returns the information about the metrics.

URL

https://{{HOST}}/timeseries/timeseries/{timeseries_id}/metrics

Method

GET

Required IMS Scopes

  • Read
  • Write

Required ACL Permissions

  • owner
  • admin
  • readwrite
  • readonly

Versions Supported

  • 2.0 (Default)
  • 2.1

URL Path Parameters

Name Description Example Type
timeseries_id
required		 Timeseries ID from which to return metrics GUID string

URL Query Parameters

Name Description Example Type
v
optional		 Version of the API to use v=2.0 string
processingType
optional		 string

Request Header Parameters

Type Value Description
Authentication Bearer {access_token}
required		 Retrieve access token
Content-Type application/json
required		 Description

Example

Request

curl -X GET 
  'https://{{HOST}}/timeseries/timeseries/920de700-8a84-4306-aef7-2676df222c6f/metrics' 
  -H 'Authorization: Bearer {access_token}' 
  -H 'Cache-Control: no-cache'

Response

[
    {
        "metric": "Raw",
        "processingType": "raw",
        "dataType": "double",
        "validateInputData": false
    },
    {
        "metric": "QuarterHourlyAverage",
        "operations": [
            {
                "operation": "Aggregate",
                "input": [
                    {
                        "timeseriesId": "920de700-8a84-4306-aef7-2676df222c6f",
                        "metric": "Raw"
                    }
                ],
                "output": [
                    {
                        "timeseriesId": "920de700-8a84-4306-aef7-2676df222c6f",
                        "metric": "QuarterHourlyAverage"
                    }
                ],
                "parameters": {
                    "function": "Average",
                    "interval": "QuarterHourly"
                }
            }
        ],
        "processingType": "stream",
        "dataType": "double",
        "validateInputData": false
    }
]

Errors

Error Description
403 Forbidden

Response Body Parameters

Name Description Schema
metric Description object definition
operations Description object definition
processingType Description object definition