Time-Series Metric Data

Gets the details of metric behavior at a certain time period. There are three common examples that show how to get metric data based on a specific time series.

Data resolution

  • e.g. url <server.com>/api/v2/metric/search?tenant=<clientId>&resource= <resourceUUID>&startTime=1236643494&endTime=1536643494
  • OpsRamp retains the raw metrics data for the most recent seven. Metric roll-ups are computed every half-hour, hourly, and daily. Calculations performed include average, minimum, maximum, and latest. Based on the selected time range, data is dynamically served in raw and rolled-up formats.
Time Range Resolution Time Series Sections
Up to 24 hours Raw data (RAW)
Greater than 24 hours to 3 days 30-minute rollup data (AVG), minVals (MIN), maxVals(MAX) and lastVals(LATEST / LAST)
Greater than 3 days to 30 days 1-hour rollup data (AVG), minVals (MIN), maxVals(MAX) and lastVals(LATEST / LAST)
Greater than 30 days 1-day rollup data (AVG), minVals (MIN), maxVals(MAX) and lastVals(LATEST / LAST)
Using "data=raw" query param Raw (up to 7 days) data (RAW)

Path Parameters

    Query Parameters

    • tenantstringrequired

      client uuid with which a metric is associated with.

    • rtypestringrequired

      rtype

      Enum:
      DEVICE
    • resourcestringrequired

      ID of the resource on which a metric is assigned.

    • metricstringrequired

      Name of the metric to report the metric details.

    • startTimestringrequired

      Search for the metric behavior within a specific time stamp with the start time (use the Unix Epoch Time Stamp format). Example: 1536643494

    • endTimestringrequired

      The end time used for the search (use the Unix Epoch Time Stamp format). Example: 1536643564

    • timeseries_typestring

      Metric behavior at a specific time series pattern. Supported values are: - "RealTime": Provides details of metric behavior at current time stamp. - "CHANGE_DETECTION": Provides details of significant changes on a metric. - "FORECAST": Provides forecast details of a metric

    • metricGroupstring

      ID of a metric group to which a metric belongs.

    • resourceGroupstring

      ID of resource group the metric is applied. Use Get Minimal Details of Device Groups API to get list of resource groups.

    • componentstring

      Device component name that the metric is assigned.

    Responses

    • resourceinteger

    • metricstring

    • metricTypestring

    • unitstring

    • unitLabelstring

    • componentstring

    • descriptionstring

    • consolFuncstring

    • factorinteger

    • dataobject

    • timeSeriesTypestring

    • minValsobject

    • maxValsobject

    • lastValsobject

    Loading Examples...