Metrics Resource

GET /metrics/searchByTopic

Returns the list of all metrics that where published under the specified Topic.
For each returned Metric its name and type will be returned. Value is not returned.
Please keep in mind that when supplying a Topic as a query parameter in a URL, proper URL encoding is necessary for characters like '+' (replace it with '%2B') and '#' (replace it with '%23').

Example

GET /metrics/searchByTopic
Content-Type: */*
Accept: application/json

                
...
                
              

HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "limitExceeded" : true,
  "metricInfo" : [ {
    "name" : "...",
    "type" : "...",
    "value" : "..."
  }, {
    "name" : "...",
    "type" : "...",
    "value" : "..."
  } ]
}
                
              

GET /metrics/values

Returns the last message published to the specified topic but only the values for the metrics specified will be contained in the response to keep it compact and efficient. While the response is modeled as a MessageResult, the result will always contain one single EdcMessage - the last one published to the specified topic. The returned EdcMessage will provide the timestamp and position of the message; the metrics contained will be limited to the one specified; no binary message body will be available. Please keep in mind that when supplying a Topic as a query parameter in a URL, proper URL encoding is necessary for characters like '+' (replace it with '%2B') and '#' (replace it with '%23').

Example

GET /metrics/values
Content-Type: */*
Accept: application/json

                
...
                
              

HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "limitExceeded" : true,
  "message" : [ {
    "topic" : "...",
    "receivedOn" : 12345,
    "payload" : {
      "sentOn" : 12345,
      "position" : { },
      "metrics" : { },
      "body" : "..."
    },
    "uuid" : "...",
    "edcTopic" : {
      "systemTopic" : true,
      "edcTopic" : true,
      "alertTopic" : true,
      "account" : "...",
      "asset" : "...",
      "semanticTopic" : "...",
      "leafName" : "...",
      "parentTopic" : "...",
      "grandParentTopic" : "...",
      "fullTopic" : "...",
      "topicParts" : [ "...", "..." ]
    }
  }, {
    "topic" : "...",
    "receivedOn" : 12345,
    "payload" : {
      "sentOn" : 12345,
      "position" : { },
      "metrics" : { },
      "body" : "..."
    },
    "uuid" : "...",
    "edcTopic" : {
      "systemTopic" : true,
      "edcTopic" : true,
      "alertTopic" : true,
      "account" : "...",
      "asset" : "...",
      "semanticTopic" : "...",
      "leafName" : "...",
      "parentTopic" : "...",
      "grandParentTopic" : "...",
      "fullTopic" : "...",
      "topicParts" : [ "...", "..." ]
    }
  } ]
}
                
              

GET /metrics/valuesByRange

Returns the list of metrics published under the given Topic with the specific range of values. This API is available only if the metrics data are indexed by value. If the index metrics data is set to "none", the query is not available. The topic, metric name, metric type and min and max values are mandatory fields for this API, while the limit, offset and sorting fields are optional. Wild cards on the topic name can be used to aggregate messages at the different topic levels. For example, a topic "edcguest/+/bus/#" can used to return all messages published under the edcguest account, across all the assets, and for all the buses. Please keep in mind that when supplying a Topic as a query parameter in a URL, proper URL encoding is necessary for characters like '+' (replace it with '%2B') and '#' (replace it with '%23').

If the flag limitExceeded is set, the maximum number of entries to be returned has been reached, more data exist and can be read by moving the offset forward in a new request

If the parameter "sort" is set to "asc", metrics are returned smaller first.

Example

GET /metrics/valuesByRange
Content-Type: */*
Accept: application/json

                
...
                
              

HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "limitExceeded" : true,
  "metricValue" : [ {
    "timestamp" : 12345,
    "value" : "...",
    "UUID" : "...",
    "uuid" : "..."
  }, {
    "timestamp" : 12345,
    "value" : "...",
    "UUID" : "...",
    "uuid" : "..."
  } ]
}
                
              

GET /metrics/valuesByTimestamp

Returns the list of metrics published under the given Topic with the specific range of timestamp. This API is available only if the metrics data are indexed by timestamp. If the index metrics data is set to "none", the query is not available. The topic, metric name, metric type and start and end date are mandatory fields for this API, while the limit, offset and sorting fields are optional. Wild cards on the topic name can be used to aggregate messages at the different topic levels. For example, a topic "edcguest/+/bus/#" can used to return all messages published under the edcguest account, across all the assets, and for all the buses. Please keep in mind that when supplying a Topic as a query parameter in a URL, proper URL encoding is necessary for characters like '+' (replace it with '%2B') and '#' (replace it with '%23').

If the flag limitExceeded is set, the maximum number of entries to be returned has been reached, more data exist and can be read by moving the offset forward in a new request

If the parameter "sort" is set to "asc", metrics are returned oldest first.

Example

GET /metrics/valuesByTimestamp
Content-Type: */*
Accept: application/json

                
...
                
              

HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "limitExceeded" : true,
  "metricValue" : [ {
    "timestamp" : 12345,
    "value" : "...",
    "UUID" : "...",
    "uuid" : "..."
  }, {
    "timestamp" : 12345,
    "value" : "...",
    "UUID" : "...",
    "uuid" : "..."
  } ]
}