1. REST API for Oracle Enterprise Manager
  2. Tasks
  3. Metrics

Get data points for numeric metric(s) over time

get

http://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/metricTimeSeries

Gets the data points for a numeric metric over specified time span. Provides single time series for a metric that does not have keys. Provides multiple time series for a metric having keys. If time span is part of raw metric data retention period (which defaults to last week), returned time series have raw data points. If time span does not fall into raw metric data retention period, but is part of hourly rollup metric data retention time period (which defaults to one month), returned time series have hourly average data points. If time span does not fall into hourly rollup metric data retention time period, returned time series have daily average data points. For each time series, relevant current threshold settings information is also included, if the optional query parameter include=currentThresholdSettings is passed in

Request

Query Parameters
  • Maximum Length: 32
    Optional parameter. If include=currentThresholdSettings query parameter is specified, response will include current threshold settings information.
    • Allowed Values: [ "currentThresholdSettings" ]
    Example:
    currentThresholdSettings
  • Optional parameter. When the metric has associated keys, query parameter having name of the form key_<name> can be used to filter for specific keys
    Example:
    key_mountPoint=/scratch&key_mountPoint=/
  • Minimum Value: 1
    Maximum Value: 20
    Limits the number of items returned in current call. Use the self/previous/next links from the response to fetch additional items.
    Default Value: 10
  • Maximum Length: 64
    Metric group name
    Example:
    Filesystems
  • Maximum Length: 64
    Metric name
    Example:
    size
  • Identifies the set of items to be fetched; "href" element from "links" list of the response provides encoded value for this parameter. "href" element value should be used "as is" for fetching respective set of items.
    Example:
    MQ%3D%3D
  • Maximum Length: 256
    Sort the results by one or more key columns. Column order should be specified as <key_column>:<sortDirection>. 'key_column' should be a valid key column for the metric in the query. 'sortDirection' can be 'ASC' (i.e., ascending order) or 'DESC' (i.e., descending order), and it defaults to 'ASC' if not specified. To sort over multiple columns, provide order for multiple columns separated by comma (i.e., ',').
    Example:
    mountPoint:DESC
  • Maximum Length: 32
    Target ID (.i.e, Target GUID). Target scope must be specified via either targetName/targetTypeName query parameters or targetId query parameter.
    Example:
    CF99A10F233254B78ED96ED1B5C15140
  • Maximum Length: 256
    Target Name. Target scope must be specified via either targetName/targetTypeName query parameters or targetId query parameter.
    Example:
    myhost.mydomain.com
  • Maximum Length: 64
    Target Type. Target scope must be specified via either targetName/targetTypeName query parameters or targetId query parameter.
    Example:
    host
  • Lower bound for the collected time of data points to be returned in time series in UTC, having yyyy-MM-dd'T'HH:mm:ss.SSS'Z' format.
    Example:
    2021-07-18T18:00:00.000Z
  • Upper bound for the collected time of data points to be returned in time series in UTC, having yyyy-MM-dd'T'HH:mm:ss.SSS'Z' format.
    Example:
    2021-07-23T23:00:00.000Z

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

OK
Body ()
Root Schema : MetricTimeSeriesCollection
Type: object
List of metric time series objects. Empty when no data exists.
Show Source
  • Number of time series present in returned items list
    Example: 1
  • items
    Provides collection of time series corresponding to the specified metric. If the metric has identifying key(s), result can have multiple time series. When no data exists for the specified time span, it would be empty.
  • links
Nested Schema : items
Type: array
Provides collection of time series corresponding to the specified metric. If the metric has identifying key(s), result can have multiple time series. When no data exists for the specified time span, it would be empty.
Show Source
Nested Schema : MetricTimeSeries
Type: object
Metric time series data from EM repository.
Show Source
Nested Schema : currentThresholdSettings
Type: object
Optional parameter. If include=currentThresholdSettings query parameter is specified, response will include current threshold settings information.
Show Source
Example:
{
    "warningThreshold":"80",
    "criticalThreshold":"90",
    "operator":">",
    "numOfOccurrences":2
}
Nested Schema : datapoints
Type: array
The list of data points in the time series. Each data point is a list of timeCollected/value attributes.
Show Source
Nested Schema : keyValues
Type: array
List of key values for the time series
Show Source
Example:
[
    {
        "name":"mountPoint",
        "displayName":"Mount Point",
        "value":"/"
    }
]
Nested Schema : NumericThresholdSettings
Type: object
Threshold settings for a numeric metric.
Show Source
Nested Schema : items
Type: array
Show Source
  • items
    List of timeCollected and value attributes. timeCollected is in UTC, and it has yyyy-MM-dd'T'HH:mm:ss.SSS'Z' format.
Nested Schema : items
Type: object
List of timeCollected and value attributes. timeCollected is in UTC, and it has yyyy-MM-dd'T'HH:mm:ss.SSS'Z' format.
Example:
[
    [
        "2021-08-25T09:35:55.000Z",
        241776.06
    ],
    [
        "2021-08-25T15:35:55.000Z",
        241776.06
    ],
    [
        "2021-08-25T21:35:55.000Z",
        241776.06
    ]
]
Nested Schema : MetricKeyValue
Type: object
Metric key value
Show Source
Examples

400 Response

Bad Request. The payload is null or missing some parameters
Body ()
Root Schema : ErrorResponse
Type: object
Error response
Show Source

401 Response

Unauthorized. The user does not have permissions to perform the requested operation
Body ()
Root Schema : ErrorResponse
Type: object
Error response
Show Source

500 Response

Internal Server Error. Exception in execution of REST API.
Body ()
Root Schema : ErrorResponse
Type: object
Error response
Show Source

503 Response

Service Unavailable. The server is unable to process the request.
Body ()
Root Schema : ErrorResponse
Type: object
Error response
Show Source
Back to Top