Get Performance Data

get

/api/metric/PerformanceData

Gets the performance data that matches the specified query parameters. If no parameters are specified, all performance data are returned.
Identify the series you want performance data for by specifying DeviceName, either Measurement or MetricType, and Instance. For example, use the following in your request:
DeviceName=router.example.com&Measurement=metrictype_Latency&Instance=Device
Identify the time ranges you want performance data for by specifying TimeRange, with start and end separated by ... Use the following letters to indicate units of time: d for m for minute, h for hour, d for day, w for week, M for month, and y for year. Use now to get dates relative to the current day. You can also enter an absolute time in YYYY-MM-DD HH-MM-SS format.
For example:
  • The last two days: now-2d..now
  • The last 6 months: now-6M..now
  • The last 5 years: now-5y..now
  • Yesterday: now-1d/d..now-1d/d
  • Today: now/d..now/d
  • This week so far: now/w..now
  • This month: now/M..now/M
  • The last 5 minutes: now-5m..now
  • The Last 24 hours: now-24h..now
  • Absolute time range: 2020-01-01 00:00:00..2020-01-01 12:00:00
Using the StartTime and StopTime parameters to specify time ranges is deprecated.
The level of aggregation for values is determined by the time range and will automatically pick the best database retention policy.

Request

Query Parameters
  • Match All
    • Device ID (or multiple, comma-separated Device IDs)
      Example: 40
  • Match All
    • Device Name (or multiple, comma-separated Device Names)
      Example: router.example.com
  • Device zone name.
  • Match All
    • Custom title to be used on the graph
  • Match All
    • Metric Instance Name (or multiple, comma-separated Metric Instance Names)
      Example: Device
  • Match All
    • Metric ID (or multiple, comma-separated Metric IDs)
      Example: 154
  • Match All
    • Metric Type Name (or multiple, comma-separated Metric Type Names)
      Example: Latency
  • Whether to include the NavigatorPoints navigation series (1) or not (0).
  • Match All
    • Show all Metrics in Metric Type Group based on single MetricID
      Example: 1
  • Deprecated way of specifying start time. Use the TimeRange parameter instead.
    Match All
    • StartTime in epoch time seconds
      Example: now
  • Deprecated way of specifying stop time. Use the TimeRange parameter instead.
    Match All
    • StopTime in epoch time seconds
      Example: now
  • Match All
    • Shorthand string that encompasses the start and end times in RFC3339 format or relative time literal format. It will take precedence over StartTime if both are passed in.
      Example: now-24h..now

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Successful operation
Body ()
Root Schema : schema
Type: object
Show Source
Nested Schema : data
Type: array
The performance data.
Show Source
Nested Schema : metricPerformanceDataRead
Type: object
Show Source
Nested Schema : AbnormalConfidence
Type: array
Abnormal confidence band points with each point containing the epoch time in milliseconds, lower value as float, and upper value as float (e.g. `[1234567890000, 0.0, 2000.00]`)
Show Source
Nested Schema : AbnormalPoints
Type: array
Abnormal data points with each point containing the epoch time in milliseconds and value as float (e.g. `[1234567890000, 1000.00]`)
Show Source
Nested Schema : NavigatorParams
Type: object
Information necessary to load the navigation asynchronously.
Show Source
Nested Schema : NavigatorPoints
Type: array
Navigator points (full history at lowest granularity) with each point containing the epoch time in milliseconds and value as float (e.g. `[1234567890000, 1000.00]`)
Show Source
Nested Schema : Points
Type: array
Data points with each point containing the epoch time in milliseconds and value as float (e.g. `[1234567890000, 1000.00]`)
Show Source
Nested Schema : Threshold
Type: array
Array of threshold definitions
Show Source
Nested Schema : TrendPoints
Type: array
Trend data points with each point containing the epoch time in milliseconds and value as float (e.g. `[1234567890000, 1000.00]`)
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : items
Type: object
Nested Schema : items
Type: array
Show Source
Nested Schema : items
Type: object
Nested Schema : items
Type: array
Show Source
Nested Schema : items
Type: object
Nested Schema : items
Type: array
Show Source
Nested Schema : items
Type: object
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : items
Type: object

Default Response

Failed operation
Body ()
Root Schema : schema
Type: object
Show Source
Nested Schema : errors
Type: array
The list of errors reported. Validation errors will be keyed by record field.
Show Source
Nested Schema : items
Type: object
Back to Top