Jump to

• Request
• Response

Get all performance data

get

/api/metric/PerformanceData

Series are identified by passing: - DeviceName - Measurement or MetricType - Instance (e.g. Recommended: `DeviceName=router.example.com&Measurement=metrictype_Latency&Instance=Device`) (e.g. SOA apps only: `DeviceName=router.example.com&MetricType=Latency&Instance=Device`) ___DEPRECATED___ - Series are identified by passing: - DeviceID - MetricID (e.g. `DeviceID=1&MetricID=1`) Time ranges are identified by passing: - TimeRange (start and end separated by `..`) Examples: - Last 2 days `now-2d..now` - Last 7 days `now-7d..now` - Last 30 days `now-30d..now` - Last 90 days `now-90d..now` - Last 6 months `now-6M..now` - Last 1 year `now-1y..now` - Last 2 years `now-2y..now` - Last 5 years `now-5y..now` - Yesterday `now-1d/d..now-1d/d` - Day before yesterday `now-2d/d..now-2d/d` - This day last week `now-7d/d..now-7d/d` - Previous week `now-1w/w..now-1w/w` - Previous month `now-1M/M..now-1M/M` - Previous year `now-1y/y..now-1y/y` - Today `now/d..now/d` - Today so far `now/d..now` - This week `now/w..now/w` - This week so far `now/w..now` - This month `now/M..now/M` - This month so far `now/M..now` - This year `now/y..now/y` - This year so far `now/y..now` - Last 5 minutes `now-5m..now` - Last 15 minutes `now-15m..now` - Last 30 minutes `now-30m..now` - Last 1 hours `now-1h..now` - Last 3 hours `now-3h..now` - Last 6 hours `now-6h..now` - Last 12 hours `now-12h..now` - Last 24 hours `now-24h..now` - Absolute `2020-01-01 00:00:00..2020-01-01 12:00:00` ___DEPRECATED___ - Time ranges are identified by passing: - StartTime - StopTime (e.g. `StartTime=1234567000&StopTime=1234567300`) The level of aggregation for values is determined by the time range and will automatically pick the best database retention policy (rp).

Request

Query Parameters

• DeviceID:
• DeviceName:
• GraphTitle:
• Instance:
• Measurement:
• MetricID:
• MetricType:
• ShowMetricGroup:
• StartTime:
• StopTime:
• TimeRange:

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Type: object

Show Source

• data: array data
  Record(s)
• message: string
  Response message in text

  Example: Loaded 1 entries
• success: boolean
  Success or failure response

  Example: true
• total: integer
  The total number of results regardless of paging

  Example: 1

{
    "properties":{
        "success":{
            "description":"Success or failure response",
            "type":"boolean",
            "example":"true"
        },
        "message":{
            "description":"Response message in text",
            "type":"string",
            "example":"Loaded 1 entries"
        },
        "total":{
            "description":"The total number of results regardless of paging",
            "type":"integer",
            "example":"1"
        },
        "data":{
            "description":"Record(s)",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/metricPerformanceDataRead"
            }
        }
    },
    "type":"object"
}

Nested Schema : data

Type: array

Record(s)

Show Source

• Array of: object metricPerformanceDataRead

{
    "description":"Record(s)",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/metricPerformanceDataRead"
    }
}

Nested Schema : metricPerformanceDataRead

Type: object

Show Source

• Abbr: string
  Unit abbreviation

  Example: b
• AbnormalConfidence: array AbnormalConfidence
  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]`)
• AbnormalPoints: array AbnormalPoints
  Abnormal data points with each point containing the epoch time in milliseconds and value as float (e.g. `[1234567890000, 1000.00]`)
• AverageUtilization: integer
  Average (mean) utilization

  Example: 50
• AverageValue: integer
  Average (mean) value

  Example: 1000
• DeviceName: string
  Device Name Defined in order or precidence from: `CustomName > DNSName > SysName > IPv6Address > IPAddress`

  Example: router.example.com
• Factor: integer
  Factor to change units into raw

  Example: 8
• GraphTitle: string
  Graph title to display based on type of data

  Example: Graph Title
• InstanceName: string
  Metric Instance Name

  Example: Device
• LastUtilization: integer
  Last utilization reported

  Example: 60
• LastValue: integer
  Last value reported

  Example: 1500
• Maximum: integer
  Metric Maximum (0 for no max)

  Example: 0
• MaximumUtilization: integer
  Maximum utilization

  Example: 100
• MaximumValue: integer
  Maximum value

  Example: 5000
• MetricGroupName: string
  Metric Group Name for displaying metrics together

  Example: Network Traffic
• MetricID: integer
  Metric ID

  Example: 1
• MetricInstanceName: string
  Metric Display (custom) Instance Name

  Example: Device
• MetricTypeName: string
  Metric Type Name

  Example: Latency
• MinimumUtilization: integer
  Minimum utilization

  Example: 0
• MinimumValue: integer
  Minimum value

  Example: 0
• NavigatorPoints: array NavigatorPoints
  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]`)
• ParentDeviceName: string
  Parent Device Name (if virtual)

  Example: parent.example.com
• PeakUtilization: integer
  Peak utilization is the minimum or maximum depending on metric type direction.

  Example: 100
• PeakValue: integer
  Peak value is the minimum or maximum depending on metric type direction.

  Example: 5000
• Points: array Points
  Data points with each point containing the epoch time in milliseconds and value as float (e.g. `[1234567890000, 1000.00]`)
• PollTime: integer
  Poll Time

  Example: 300
• Stacked: integer
  Stacking of metrics enabled

  Example: 0
• StartTime: integer
  Starting epochtime in seconds

  Example: 1234567890
• StopTime: integer
  Stoping epochtime in seconds

  Example: 1234567890
• SumValue: integer
  Sum of value (over polltime). Not valid for all metrics.

  Example: 300000
• Threshold: array Threshold
  Array of threshold definitions
• TrendPoints: array TrendPoints
  Trend data points with each point containing the epoch time in milliseconds and value as float (e.g. `[1234567890000, 1000.00]`)
• TrendSlope: integer
  Slope of points over time range

  Example: 0.1
• Unit: string
  Value unit

  Example: bits
• UnitDivision: integer
  Unit division factor

  Example: 1024

{
    "properties":{
        "DeviceName":{
            "description":"Device Name\n\nDefined in order or precidence from:\n\n`CustomName > DNSName > SysName > IPv6Address > IPAddress`",
            "type":"string",
            "example":"router.example.com"
        },
        "StartTime":{
            "description":"Starting epochtime in seconds",
            "type":"integer",
            "example":"1234567890"
        },
        "StopTime":{
            "description":"Stoping epochtime in seconds",
            "type":"integer",
            "example":"1234567890"
        },
        "MetricInstanceName":{
            "description":"Metric Display (custom) Instance Name",
            "type":"string",
            "example":"Device"
        },
        "ParentDeviceName":{
            "description":"Parent Device Name (if virtual)",
            "type":"string",
            "example":"parent.example.com"
        },
        "InstanceName":{
            "description":"Metric Instance Name",
            "type":"string",
            "example":"Device"
        },
        "MetricTypeName":{
            "description":"Metric Type Name",
            "type":"string",
            "example":"Latency"
        },
        "Unit":{
            "description":"Value unit",
            "type":"string",
            "example":"bits"
        },
        "Abbr":{
            "description":"Unit abbreviation",
            "type":"string",
            "example":"b"
        },
        "UnitDivision":{
            "description":"Unit division factor",
            "type":"integer",
            "example":"1024"
        },
        "Maximum":{
            "description":"Metric Maximum (0 for no max)",
            "type":"integer",
            "example":"0"
        },
        "MetricID":{
            "description":"Metric ID",
            "type":"integer",
            "example":"1"
        },
        "Factor":{
            "description":"Factor to change units into raw",
            "type":"integer",
            "example":"8"
        },
        "PollTime":{
            "description":"Poll Time",
            "type":"integer",
            "example":"300"
        },
        "MetricGroupName":{
            "description":"Metric Group Name for displaying metrics together",
            "type":"string",
            "example":"Network Traffic"
        },
        "Stacked":{
            "description":"Stacking of metrics enabled",
            "type":"integer",
            "example":"0"
        },
        "AverageValue":{
            "description":"Average (mean) value",
            "type":"integer",
            "example":"1000"
        },
        "MinimumValue":{
            "description":"Minimum value",
            "type":"integer",
            "example":"0"
        },
        "MaximumValue":{
            "description":"Maximum value",
            "type":"integer",
            "example":"5000"
        },
        "SumValue":{
            "description":"Sum of value (over polltime). Not valid for all metrics.",
            "type":"integer",
            "example":"300000"
        },
        "LastValue":{
            "description":"Last value reported",
            "type":"integer",
            "example":"1500"
        },
        "PeakValue":{
            "description":"Peak value is the minimum or maximum depending on metric type direction.",
            "type":"integer",
            "example":"5000"
        },
        "AverageUtilization":{
            "description":"Average (mean) utilization",
            "type":"integer",
            "example":"50"
        },
        "MinimumUtilization":{
            "description":"Minimum utilization",
            "type":"integer",
            "example":"0"
        },
        "MaximumUtilization":{
            "description":"Maximum utilization",
            "type":"integer",
            "example":"100"
        },
        "LastUtilization":{
            "description":"Last utilization reported",
            "type":"integer",
            "example":"60"
        },
        "PeakUtilization":{
            "description":"Peak utilization is the minimum or maximum depending on metric type direction.",
            "type":"integer",
            "example":"100"
        },
        "TrendSlope":{
            "description":"Slope of points over time range",
            "type":"integer",
            "example":"0.1"
        },
        "GraphTitle":{
            "description":"Graph title to display based on type of data",
            "type":"string",
            "example":"Graph Title"
        },
        "Points":{
            "description":"Data points with each point containing the epoch time in milliseconds and value as float\n\n(e.g. `[1234567890000, 1000.00]`)",
            "type":"array",
            "items":{
                "type":"array",
                "items":{
                    "type":"object"
                }
            }
        },
        "AbnormalPoints":{
            "description":"Abnormal data points with each point containing the epoch time in milliseconds and value as float\n\n(e.g. `[1234567890000, 1000.00]`)",
            "type":"array",
            "items":{
                "type":"array",
                "items":{
                    "type":"object"
                }
            }
        },
        "AbnormalConfidence":{
            "description":"Abnormal confidence band points with each point containing the epoch time in milliseconds, lower value as float, and upper value as float\n\n(e.g. `[1234567890000, 0.0, 2000.00]`)",
            "type":"array",
            "items":{
                "type":"array",
                "items":{
                    "type":"object"
                }
            }
        },
        "NavigatorPoints":{
            "description":"Navigator points (full history at lowest granularity) with each point containing the epoch time in milliseconds and value as float\n\n(e.g. `[1234567890000, 1000.00]`)",
            "type":"array",
            "items":{
                "type":"array",
                "items":{
                    "type":"object"
                }
            }
        },
        "TrendPoints":{
            "description":"Trend data points with each point containing the epoch time in milliseconds and value as float\n\n(e.g. `[1234567890000, 1000.00]`)",
            "type":"array",
            "items":{
                "type":"array",
                "items":{
                    "type":"object"
                }
            }
        },
        "Threshold":{
            "description":"Array of threshold definitions",
            "type":"array",
            "items":{
                "type":"object"
            }
        }
    },
    "type":"object"
}

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

• Array of: array items

{
    "description":"Abnormal confidence band points with each point containing the epoch time in milliseconds, lower value as float, and upper value as float\n\n(e.g. `[1234567890000, 0.0, 2000.00]`)",
    "type":"array",
    "items":{
        "type":"array",
        "items":{
            "type":"object"
        }
    }
}

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

• Array of: array items

{
    "description":"Abnormal data points with each point containing the epoch time in milliseconds and value as float\n\n(e.g. `[1234567890000, 1000.00]`)",
    "type":"array",
    "items":{
        "type":"array",
        "items":{
            "type":"object"
        }
    }
}

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

• Array of: array items

{
    "description":"Navigator points (full history at lowest granularity) with each point containing the epoch time in milliseconds and value as float\n\n(e.g. `[1234567890000, 1000.00]`)",
    "type":"array",
    "items":{
        "type":"array",
        "items":{
            "type":"object"
        }
    }
}

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

• Array of: array items

{
    "description":"Data points with each point containing the epoch time in milliseconds and value as float\n\n(e.g. `[1234567890000, 1000.00]`)",
    "type":"array",
    "items":{
        "type":"array",
        "items":{
            "type":"object"
        }
    }
}

Nested Schema : Threshold

Type: array

Array of threshold definitions

Show Source

• Array of: object items

{
    "description":"Array of threshold definitions",
    "type":"array",
    "items":{
        "type":"object"
    }
}

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

• Array of: array items

{
    "description":"Trend data points with each point containing the epoch time in milliseconds and value as float\n\n(e.g. `[1234567890000, 1000.00]`)",
    "type":"array",
    "items":{
        "type":"array",
        "items":{
            "type":"object"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

Nested Schema : items

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

Nested Schema : items

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

Nested Schema : items

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

Nested Schema : items

Type: object

Nested Schema : items

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

Default Response

Failed operation

Body ()

Root Schema : schema

Type: object

Show Source

• errors: array errors
  List of errors reported. Validation errors will be keyed by record field.
• message: string
  Response message in text

  Example: Exception thrown
• success: boolean
  Success or failure response

  Example: false

{
    "properties":{
        "success":{
            "description":"Success or failure response",
            "type":"boolean",
            "example":"false"
        },
        "message":{
            "description":"Response message in text",
            "type":"string",
            "example":"Exception thrown"
        },
        "errors":{
            "description":"List of errors reported. Validation errors will be keyed by record field.",
            "type":"array",
            "items":{
                "type":"object"
            }
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

List of errors reported. Validation errors will be keyed by record field.

Show Source

• Array of: object items

{
    "description":"List of errors reported. Validation errors will be keyed by record field.",
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

Back to Top