Jump to

• Request
• Response
• Examples

Get Summary Performance Information

get

/api/metric/PerformanceData/readSummary

Gets summary, or legend, performance information. You can specify either of the following combinations:

• DeviceID and MetricID

  /api/metric/PerformanceData/readSummary?DeviceID=123&MetricID=456&TimeRange=now-24h..now

• DeviceName, DeviceZoneName, MetricType, and InstanceName

  /api/metric/PerformanceData/readSummary?DeviceName=router.example.com&DeviceZoneName=MyZoneName&MetricType=Latency&InstanceName=Device&TimeRange=now-24h..now

If you specify both, the IDs takes precedence.

Request

Query Parameters

• DeviceID:
  The ID of the device to get performance information for (or multiple, comma-separated device IDs).

  Match All

  • string
    Device ID (or multiple, comma-separated Device IDs)

    Example: 40

  {
      "allOf":[
          {
              "$ref":"#/components/schemas/metricPerformanceData/properties/DeviceID"
          }
      ]
  }

• DeviceName:
  The name of the device to get performance information for (or multiple, comma-separated device names).

  Match All

  • string
    The serialized device name (or multiple, comma-separated serialized device names). The device name may be serialized (include the zone id) or just the name if the zone is included separately.

    Example: router.example.com OR router.example.com;z1

  {
      "allOf":[
          {
              "$ref":"#/components/schemas/metricPerformanceData/properties/DeviceName"
          }
      ]
  }

• DeviceZoneName: string
  The name of the device zone to get performance information for. Deprecated. Use serialized device name instead.
• InstanceName: string
  The name of the metric instance to get performance information for.
• MetricID:
  The ID of the metric to get performance information for (or multiple, comma-separated metric IDs).

  Match All

  • string
    Metric ID (or multiple, comma-separated Metric IDs)

    Example: 154

  {
      "allOf":[
          {
              "$ref":"#/components/schemas/metricPerformanceData/properties/MetricID"
          }
      ]
  }

• MetricType: string
  The name of the metric type to get performance information for.
• StartTime:
  The start time in epoch time seconds.

  Match All

  • integer
    StartTime in epoch time seconds

    Example: now

  {
      "allOf":[
          {
              "$ref":"#/components/parameters/StartTime"
          }
      ]
  }

• StopTime:
  The stop time in epoch time seconds.

  Match All

  • integer
    StopTime in epoch time seconds

    Example: now

  {
      "allOf":[
          {
              "$ref":"#/components/parameters/StopTime"
          }
      ]
  }

• TimeRange:
  A shorthand string that encompasses the start and end times in RFC3339 format or relative time literal format. Takes precedence over StartTime if both are passed in.

  Match All

  • string
    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

  {
      "allOf":[
          {
              "$ref":"#/components/parameters/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

Match All

Show Source

• object SuccessfulGetOperation
  The response body for a successful get operation.
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulGetOperation"
        },
        {
            "type":"object",
            "properties":{
                "data":{
                    "description":"The performance data summary that matches the query parameters.",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/metricPerformanceDataReadSummary"
                    }
                }
            }
        }
    ]
}

Nested Schema : SuccessfulGetOperation

Type: object

The response body for a successful get operation.

Show Source

• message: string
  The response message.

  Example: Loaded 1 entries
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: true

{
    "description":"The response body for a successful get operation.",
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"true"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Loaded 1 entries"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

• data: array data
  The performance data summary that matches the query parameters.

{
    "type":"object",
    "properties":{
        "data":{
            "description":"The performance data summary that matches the query parameters.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/metricPerformanceDataReadSummary"
            }
        }
    }
}

Nested Schema : data

Type: array

The performance data summary that matches the query parameters.

Show Source

• Array of: object metricPerformanceDataReadSummary

{
    "description":"The performance data summary that matches the query parameters.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/metricPerformanceDataReadSummary"
    }
}

Nested Schema : metricPerformanceDataReadSummary

Type: object

Show Source

• Abbr: string
  Unit abbreviation

  Example: b
• AverageAvailability: number
  Average Availability

  Example: 1
• AverageUtilization: number
  Average (mean) utilization

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

  Example: 1000
• Factor: integer
  Factor to change units into raw

  Example: 8
• InstanceName: string
  Metric Instance Name

  Example: Device
• LastAvailability: number
  Last Availability

  Example: 1
• LastUtilization: number
  Last utilization reported

  Example: 60
• LastValue: number
  Last value reported

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

  Example: 0
• MaximumAvailability: number
  Maximum Availability

  Example: 1
• MaximumUtilization: number
  Maximum utilization

  Example: 100
• MaximumValue: number
  Maximum value

  Example: 5000
• Measurement: string
  InfluxDB measurement name (or multiple, comma-separated measurements).

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

  Example: Device
• MetricTypeName: string
  Metric Type Name

  Example: Latency
• MinimumAvailability: number
  Minimum Availability

  Example: 1
• MinimumUtilization: number
  Minimum utilization

  Example: 0
• MinimumValue: number
  Minimum value

  Example: 0
• PollTime: integer
  Poll Time

  Example: 300
• SumValue: number
  Sum of values over the time range. Not valid for all metrics.

  Example: 300000
• Unit: string
  Value unit

  Example: bits
• UnitDivision: integer
  Unit division factor

  Example: 1024

{
    "properties":{
        "MetricInstanceName":{
            "$ref":"#/components/schemas/metricPerformanceDataRead/properties/MetricInstanceName"
        },
        "Maximum":{
            "$ref":"#/components/schemas/metricPerformanceDataRead/properties/Maximum"
        },
        "InstanceName":{
            "$ref":"#/components/schemas/metricPerformanceDataRead/properties/InstanceName"
        },
        "MetricTypeName":{
            "$ref":"#/components/schemas/metricPerformanceDataRead/properties/MetricTypeName"
        },
        "Measurement":{
            "description":"InfluxDB measurement name (or multiple, comma-separated measurements).",
            "type":"string",
            "example":"metrictype_Latency"
        },
        "Unit":{
            "$ref":"#/components/schemas/metricPerformanceDataRead/properties/Unit"
        },
        "Abbr":{
            "$ref":"#/components/schemas/metricPerformanceDataRead/properties/Abbr"
        },
        "UnitDivision":{
            "$ref":"#/components/schemas/metricPerformanceDataRead/properties/UnitDivision"
        },
        "Factor":{
            "$ref":"#/components/schemas/metricPerformanceDataRead/properties/Factor"
        },
        "PollTime":{
            "$ref":"#/components/schemas/metricPerformanceDataRead/properties/PollTime"
        },
        "AverageValue":{
            "$ref":"#/components/schemas/metricPerformanceDataRead/properties/AverageValue"
        },
        "MinimumValue":{
            "$ref":"#/components/schemas/metricPerformanceDataRead/properties/MinimumValue"
        },
        "MaximumValue":{
            "$ref":"#/components/schemas/metricPerformanceDataRead/properties/MaximumValue"
        },
        "SumValue":{
            "$ref":"#/components/schemas/metricPerformanceDataRead/properties/SumValue"
        },
        "LastValue":{
            "$ref":"#/components/schemas/metricPerformanceDataRead/properties/LastValue"
        },
        "AverageAvailability":{
            "description":"Average Availability",
            "type":"number",
            "example":"1"
        },
        "MinimumAvailability":{
            "description":"Minimum Availability",
            "type":"number",
            "example":"1"
        },
        "MaximumAvailability":{
            "description":"Maximum Availability",
            "type":"number",
            "example":"1"
        },
        "LastAvailability":{
            "description":"Last Availability",
            "type":"number",
            "example":"1"
        },
        "AverageUtilization":{
            "$ref":"#/components/schemas/metricPerformanceDataRead/properties/AverageUtilization"
        },
        "MinimumUtilization":{
            "$ref":"#/components/schemas/metricPerformanceDataRead/properties/MinimumUtilization"
        },
        "MaximumUtilization":{
            "$ref":"#/components/schemas/metricPerformanceDataRead/properties/MaximumUtilization"
        },
        "LastUtilization":{
            "$ref":"#/components/schemas/metricPerformanceDataRead/properties/LastUtilization"
        }
    },
    "type":"object"
}

Default Response

Failed operation

Body ()

Root Schema : schema

Type: object

Show Source

• errors: array errors
  The list of errors reported. Validation errors will be keyed by record field.
• message: string
  The response message.

  Example: Exception thrown
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: false

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"false"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Exception thrown"
        },
        "errors":{
            "description":"The list of errors reported. Validation errors will be keyed by record field.",
            "type":"array",
            "items":{
                "description":"An error.",
                "type":"object"
            }
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

The list of errors reported. Validation errors will be keyed by record field.

Show Source

• Array of: object items
  An error.

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

Nested Schema : items

Type: object

An error.

Back to Top

Examples

The following examples show how to use query parameters in Get Summary Performance Information requests.

You can submit requests using cURL, an API client, or your browser.

To use the DeviceID and MetricID parameters:

http://hostFQDN/api/metric/PerformanceData/readSummary?DeviceID=123&MetricID=456&TimeRange=now-24h..now

To use the DeviceName, DeviceZoneName, MetricType, and InstanceName parameters:

http://hostFQDN/api/metric/PerformanceData/readSummary?DeviceName=router.example.com&DeviceZoneName=MyZoneName&MetricType=Latency&InstanceName=Device&TimeRange=now-24h..now

If you specify a combination of name and ID parameters (for example, both DeviceName and DeviceID), the value in the ID is used.

Example of the Response Body

The following example shows the contents of the response body in JSON format:

{
  "success": "true",
  "message": "Loaded 1 entries",
  "data": [
    {
      "MetricInstanceName": "Device",
      "Maximum": "0",
      "InstanceName": "Device",
      "MetricTypeName": "Latency",
      "Measurement": "metrictype_Latency",
      "Unit": "bits",
      "Abbr": "b",
      "UnitDivision": "1024",
      "Factor": "8",
      "PollTime": "300",
      "AverageValue": "1000",
      "MinimumValue": "0",
      "MaximumValue": "5000",
      "SumValue": "300000",
      "LastValue": "1500",
      "AverageAvailability": "1",
      "MinimumAvailability": "1",
      "MaximumAvailability": "1",
      "LastAvailability": "1",
      "AverageUtilization": "50",
      "MinimumUtilization": "0",
      "MaximumUtilization": "100",
      "LastUtilization": "60"
    }
  ]
}

Back to Top