1. REST API for Unified Assurance Core
  2. Tasks
  3. Metrics
  4. Performance Data

Get Performance Data Details for a Grid Display

get

/api/metric/PerformanceData/readDetails

Gets performance data details for a grid display. You can specify any of the following combinations:
  • DeviceID and MetricID 
    /api/metric/PerformanceData/readDetails?DeviceID=123&MetricID=456&TimeRange=now-24h..now
  • DeviceName, DeviceZoneName, MetricType, and Instance 
    /api/metric/PerformanceData/readDetails?DeviceName=router.example.com&DeviceZoneName=MyZoneName&MetricType=Latency&InstanceName=Device&TimeRange=now-24h..now
  • Serialized DeviceName, MetricType, and Instance 
    /api/metric/PerformanceData/readDetails?DeviceName=router.example.com;z1&MetricType=Latency&InstanceName=Device&TimeRange=now-24h..now
If you specify both, the names take precedence.

Request

Query Parameters
  • The single character used to separate names in string values of the DeviceName, Instance, MetricType, and DeviceZoneName parameters.
  • Match All
    • Device ID (or multiple, comma-separated Device IDs)
      Example: 40
  • Match All
    • 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
  • The ID of the device zone to get performance data for. Deprecated. Use serialized device name instead.
    Example:
    1
  • The name of the device zone to get performance data for. Deprecated. Use serialized device name instead.
    Example:
    Default First Zone
  • 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
  • Match All
    • Show all Metrics in Metric Type Group based on single MetricID
      Example: 1
  • 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
  • The number of records to limit results by. If you do not also set the start parameter, records start at 0.
    Example:
    100
  • The page of results to start from. This parameter is ignored if you do not also set the limit parameter.
    Default Value: 0
    Example:
    1

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Successful operation
Body ()
Root Schema : schema
Match All
Show Source
Nested Schema : SuccessfulGetOperation
Type: object
The response body for a successful get operation.
Show Source
Nested Schema : type
Type: object
Show Source
  • data
    The data contents are dynamic based on the data to be gathered. It will always contain Time and EpochTime. Every other column will depend on the data. The values are the string "Value_" concatenated with the metric ID.
  • metaData
    A description of the data.
  • The total number of results regardless of paging.
    Example: 1
Nested Schema : data
Type: array
The data contents are dynamic based on the data to be gathered. It will always contain Time and EpochTime. Every other column will depend on the data. The values are the string "Value_" concatenated with the metric ID.
Show Source
Nested Schema : metaData
Type: array
A description of the data.
Show Source
Nested Schema : metricPerformanceDataReadDetails
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : columns
Type: array
A description of the columns the data should be displayed in.
Show Source
Nested Schema : fields
Type: array
The data index to link data to the columns.
Show Source
Nested Schema : items
Type: object
Show Source

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
An error.
Back to Top

Examples

The following examples show how to use query parameters in Get Performance Data Details for a Grid Display requests using different combinations of parameters to specify the device and metric.

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

To use DeviceID for the device and MetricID for the metric:

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

To use DeviceName, DeviceZoneName, and InstanceName for the device and MetricType for the metric:

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

To use a serialized DeviceName for the device:

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

Example of the Response Body

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

{
  "success": "true",
  "message": "Loaded 1 entries",
  "total": "1",
  "data": [
    {
      "Time": "2023-10-03 04:20:00",
      "EpochTime": 1696324800000,
      "Value_157": 0.000508975982666016,
      "Value_158": 0,
      "Value_159": 0.000560310151841905
    }
  ],
  "metaData": [
    {
      "GraphTitle": "string",
      "root": "string",
      "columns": [
        {
          "dataIndex": "string",
          "minWidth": 0,
          "test": "string",
          "width": 0,
          "flex": 0
        }
      ],
      "fields": [
        "string"
      ]
    }
  ]
}
Back to Top