Retrieve Performance Data Using the Multi-Device-TimeSeries API

The Multi-Device-TimeSeries API retrieves all performance data of a certain type from all managed devices in Netreo. The returned data set is filtered by data set type, device group, and time (either a specified range or a time offset from the current time).

Most of the parameters for this API are well covered in the API documentation (https://app.swaggerhub.com/apis-docs/Netreo/multi-device_timeseries_api/). However, some of the required parameters may need additional explanation regarding where you can find their values in Netreo. This document covers those parameters.

metricFilterStatGroup

The value you must supply for this parameter is the Statistical Group of the data set to be retrieved (this value was formerly known as the ATA Category).

There are three locations from which the Statistical Group of the data set you want can be retrieved:

• The documentation for a device type that collects that set of performance data.
• The Device Dashboard for a managed device that collects that set of performance data.
• The configuration page for a device type that collects that set of performance data.

For all these options, you must still know which device types or subtypes collect the data set you want to retrieve with the API.

Device Type Documentation

The simplest and fastest way to determine the name of the Statistical Group for a given metric you want to retrieve. Also, potentially the least accurate method, as the documentation might not be available or up-to-date. (It is recommended to determine the required Statistical Group name by referring to the Netreo user interface by using one of the other methods listed below.)

Simply locate the device type/subtype documentation for a managed device that reports the metric you want to retrieve.

Device type/subtype documentation is listed under Device Type/Subtype Management.

Device Dashboard

The simplest and fastest way to accurately determine the name of the Statistical Group for a given metric you want to retrieve.

Navigate to the Performance tab of a Device Dashboard for a managed device that reports the metric you want to retrieve. On the left is the Navigation area for the metrics. The large, bold headings are the Statistical Groups (e.g., Latency, CPU, Memory, etc.). Locate the metric you want to retrieve in the list (metrics have a small colored dot to the left of their name). The heading under which that metric appears is its Statistical Group.

Device Type/Subtype

The most complex (but completely accurate) way to determine the name of the Statistical Group for a given metric you want to retrieve. But it also allows you to accurately retrieve the unit type for the metric at the same time. (This is the recommended way to retrieve these items.) You must also already know which device type/subtype reports the metric you want to retrieve.

(This method applies only to devices polled by SNMP. Devices polled by API or other means will have to rely on using the Device Dashboard or documentation methods above.)

You must be logged in to Netreo as a user with the SuperAdmin access level.

• Select Administration >> Change Devices >> Edit Device Types/Subtypes from the main menu to open the Polling Administration page.
• If you are looking up a metric for a device subtype, click the View Subtypes button. Otherwise, continue on.
• In the list, locate the relevant device type/subtype and click its edit icon to open its edit page.
• In the SNMP Pollers section, locate the poller relevant to the metric you want to retrieve and click its edit icon to open its edit page.
• Locate the STATISTICAL GROUP field near the bottom of the configuration area. This is the Statistical Group for this metric.
• While you're here, locate the UNITS field higher up. You will also need this value for the metricFilterUnits parameter discussed below.

metricFilterUnits

The value you must supply for this parameter is the literal string value for the unit type in which the metric value is provided (e.g., "%", "procs", "b/s", etc.). This value is arbitrary in the poller configuration, so you must determine the correct string to use as the parameter value.

Unit types are usually visible alongside the metric values displayed on the Performance tab of the Device Dashboard and in the documentation for the specific device type/subtype (as discussed above for the metricFilterStatGroup parameter), but the safest place to retrieve the unit type value is from the configuration page of the relevant device type/subtype. Follow the procedure under Device Type/Subtype for the metricFilterStatGroup parameter above.