OpenAPI QueryBuilder Examples

The following examples highlight the flexibility of the OpenAPI. Use these examples as a model to create your own OpenAPI queries:
capm360
The following examples highlight the flexibility of the OpenAPI. Use these examples as a model to create your own OpenAPI queries:
Export Inventory and Configuration Details
The following examples show how to extract lists of items from inventory with specific configuration details.
Get a List of All Devices with Cisco in the Name
You want to get a list of Cisco devices and IP addresses of those devices. For these devices, you know that the device name includes "Cisco".
To get this list, use the following tokens to build the query:
  • for: device
  • select: ID, Name, PrimaryIPAddress
  • filter: name contains cisco
OpenAPI URL:
http://
da_host
:8581/odata/api/devices?$select=ID,Name,PrimaryIPAddress&$filter=((groups/Name eq 'cisco'))
Get a List of Devices and Location Information
You want a list of Cisco devices and the location information (location, latitude, longitude, location description, and elevation) for those devices.
The
Location
attribute is tied to the MIB
sysLocation
value. The
Latitude
,
Longitude
,
LocationDesc
, and
Elevation
attributes are user-defined values. An administrator must set these values on the Data Aggregator. If these values are not set, they return a null result.
To get this list, use the following tokens to build the query:
  • for: device
  • select: ID, Name, PrimaryIPAddress, Location, Latitude, Longitude, LocationDesc, Elevation
  • filter: name contains cisco
OpenAPI URL:
 
http://
da_host
:8581/odata/api/devices?$select=ID,Name,PrimaryIPAddress,Location,Latitude,Longitude,LocationDesc,Elevation&$filter=((groups/Name eq 'cisco'))
Get a List of Devices and Components If the Device IP Address Begins with 10.251
You want a list of all devices where the IP address begins with 10.251. You also want a list of the components for those devices.
The
expand
token lets you get items that are related to the main entity of the query.
To get this list, use the following tokens to build the query:
  • for: device
  • select: ID, Name, PrimaryIPAddress
  • filter: PrimaryIPAddress starts with 10.251
  • expand: components, DisplayName
OpenAPI URL:
http://
da_host
:8581/odata/api/devices?$expand=components&$select=ID,Name,PrimaryIPAddress,components/DisplayName&$filter=((startswith(PrimaryIPAddress, '10.251') eq true))
Get a List of Devices and Components in the Boston Group
You want a list of all devices in the Boston group. You also want a list of the components for those devices.
When you selected a group filter, OpenAPI always includes subgroups of the selected group.
To get this list, use the following tokens to build the query:
  • for: device
  • select: ID, Name, PrimaryIPAddress
  • filter: groups/Name equal Boston
  • expand: components, DisplayName
OpenAPI URL:
http://
da_host
:8581/odata/api/devices?$expand=components&$select=ID,Name,PrimaryIPAddress,components/DisplayName&$filter=((groups/Name eq 'Boston'))
Get a List of Metric Families and Vendor Certifications for a Specific Device
You want to know which metric families and vendor certifications are used to monitor specific devices. From this list, you can derive the available metrics for a device. The name of the device is MyDevice-123.
To get this list, use the following tokens to build the query:
  • for: device
  • filter: DisplayName equal MyDevice-123
  • select: ID, Name
  • expand: metricfamilyhistory, MetricFamilyID, VendorCertDisplayName
OpenAPI URL:
http://
da_host
:8581/odata/api/devices?$expand=metricfamilyhistories&$select=ID,Name,metricfamilyhistories/MetricFamilyID,metricfamilyhistories/VendorCertDisplayName&$filter=((DisplayName eq 'MyDevice-123'))
Get a List of Supported Metric Families
You want to know which metrics are available for reporting. From a list of metric families, you can determine which metric families are supported by which monitored devices.
To get this list, use the following tokens to build the query:
  • for: metricfamilyhistory
  • select: Status
  • expand: device/ID, device/Name, metricfamilydef/ID, metricfamilydef/DisplayName, metricfamilydef/DisplayDescription, 
    metricdefs/ID, metricdefs/DisplayName, metricdefs/DisplayDecsription, 
  • filter: Status/Status equal SUPPORTED
OpenAPI URL: 
http://
da_host
:8581/odata/api/metricfamilyhistories?$expand=metricfamilydef,metricdefs,device&$select=device/ID,device/Name,Status,metricfamilydef/ID,metricfamilydef/DisplayName,metricfamilydef/DisplayDescription,metricdefs/ID,metricdefs/DisplayName,metricdefs/DisplayDescription&$filter=((Status eq 'SUPPORTED'))
Export Inventory and Monitoring Data
The following examples show how to extract monitoring data for items with specific configuration details or monitoring status.
List the Interfaces in the North America Group That Are Not Being Polled
You want to know which interfaces in the North America group are not currently being monitored.
To get this list, use the following tokens to build the query:
  • for: interface
  • select: ID, Name
  • filter: groups/Name equal North America and IsPolled False 
     
OpenAPI URL:
http://
da_host
:8581/odata/api/interfaces?$select=ID,Name&$filter=((groups/Name eq 'North America') and (IsPolled eq false))
Get the Polling Statistics for Devices in a Group for the Last 24 Hours
You want to know the success and failure rate of devices in the Boston group for the last 24 hours. The database does not store the number of unsuccessful polls. To derive this value, use the
group aggregate
token to subtract the number of successful polls from the number of polls sent.
Time selections are absolute. When you select the time for the query, that time is fixed. To create a query with a flexible time, use a script to replace the time and data in the query.
To get this data, use the following tokens to build the query:
  • for: device
  • select: Name
  • expand metrics: devicepollingstatisticsmfs: im_NumSuccessfulPolls
  • group aggregate:
    • Group By: devicepollingstatisticsmfs, ID
    • Add an Aggregation Function:
      Sum Of
      im_NumPollsSent sub im_NumSuccessfulPolls
  • filter: groups/Name equal Boston
  • time range: Last24Hours
OpenAPI URL:
http://
da_host
:8581
/odata/api/devices?$apply=groupby(devicepollingstatisticsmfs/ID, aggregate(devicepollingstatisticsmfs(im_NumPollsSent sub im_NumSuccessfulPolls with sum as Value)))&period=1d&resolution=RATE&$expand=devicepollingstatisticsmfs&$select=Name,devicepollingstatisticsmfs/im_NumSuccessfulPolls&$filter=((groups/Name eq 'Boston'))
Get a List of Devices with More Than 25 Percent Polling Failures in the Last 30 Days
You want to identify devices that respond inconsistently to poll requests. For this query, use the aggregation function to calculate the poll failure rate, then set a limit against that value.
The
group aggregate
token enables you to derive values from metrics in the system. In the results, the aggregated data is reported as "Value". You can use Value as a filter criteria for the filter metrics token.
To get this data, use the following tokens to build the query:
  • for: device
  • select: Name
  • group aggregate:
    • Group By: devicepollingstatisticsmfs, ID
    • Add an Aggregation Function:
      Sum Of
      ((im_NumPollsSent sub im_NumSuccessfulPolls) div im_NumPollsSent) mul 100
  • filter metrics: devicepollingstatisticsmfs/Value greater 25
  • time range: Last30Days
OpenAPI URL:
http://
da_host
:8581
/odata/api/devices?$apply=groupby(devicepollingstatisticsmfs/ID, aggregate(devicepollingstatisticsmfs(((im_NumPollsSent sub im_NumSuccessfulPolls) div im_NumPollsSent) mul 100 with sum as Value)))&period=1m&resolution=RATE&$select=Name&$filter=((devicepollingstatisticsmfs/Value gt 25))
Export Device Status
The following examples show how to extract details regarding device statuses.
Get a List of All Devices from the Last 24 Hours with Management Issues
You want to identify recent devices with management issues.
To get this data, use the following tokens to build the query:
  • for: device
  • select: ID, Name
  • group aggregate:
    • Group By: availabilitymfs, DeviceItemID
    • Add an Aggregation Function:
      Count Distinct Of
       (Timestamp)
  • filter metrics: availabilitymfs/Value less 1
  • time range: Last24Hours/As polled
  • limit(top): top=2000, skip=0, expandtop=0
OpenAPI URL:
 http://
da_host
:8581/odata/api/devices?$apply=groupby(availabilitymfs/DeviceItemID, aggregate(availabilitymfs(Timestamp with countdistinct as Value)))&resolution=RATE&period=1d&$top=2000&$skip=0&top=0&$select=ID,Name&$filter=((availabilitymfs/Value lt 1))
Get a List of All Devices from the Last 24 Hours with Reachability Issues
You want to identify recent devices with reachability issues.
To get this data, use the following tokens to build the query:
  • for: device
  • select: ID, Name
  • group aggregate:
    • Group By: reachabilitymfs, DeviceItemID
    • Add an Aggregation Function: 
      Count Distinct Of
       (Timestamp)
  • filter metrics: reachabilitymfs/Value less 1
  • time range: Last24Hours/As polled
  • limit(top): top=2000, skip=0, expandtop=0
OpenAPI URL: http://
da_host
:
8581/odata/api/devices?$apply=groupby(reachabilitymfs/DeviceItemID, aggregate(reachabilitymfs(Timestamp with countdistinct as Value)))&resolution=RATE&period=1d&$top=2000&$skip=0&top=0&$select=ID,Name&$filter=((reachabilitymfs/Value lt 1))
Get a List of All Devices from the Last 24 Hours that are Up without a Single CPU Polled
You want to identify devices that need CPU metric polling restarted.
To get this data, use the following tokens to build the query:
  • for: device
  • select: ID, Name
  • group aggregate:
    • Group By: cpumfs, DeviceItemID
    • Add an Aggregation Function: 
      Count Distinct Of
       (Timestamp)
  • filter metrics: cpumfs/Value less 1
  • time range: Last24Hours/As polled
  • limit(top): top=2000, skip=0, expandtop=0
OpenAPI URL: http://
da_host
:
8581//odata/api/devices?$apply=groupby(cpumfs/DeviceItemID, aggregate(cpumfs(Timestamp with countdistinct as Value)))&resolution=RATE&period=1d&$top=2000&$skip=0&top=0&$select=ID,Name&$filter=((cpumfs/Value lt 1))
Get a List of All Devices from the Last 24 Hours that are Up without a Single Interface Polled
You want to identify that the devices that need Interface metric polling restarted.
To get this data, use the following tokens to build the query:
  • for: device
  • select: ID, Name
  • group aggregate:
    • Group By: portmfs, DeviceItemID
    • Add an Aggregation Function: 
      Count Distinct Of
       (Timestamp)
  • filter metrics: portmfs/Value less 1
  • time range: Last24Hours/As polled
  • limit(top): top=2000, skip=0, expandtop=0
OpenAPI URL: http://
da_host
:
8581/odata/api/devices?$apply=groupby(portmfs/DeviceItemID, aggregate(portmfs(Timestamp with countdistinct as Value)))&resolution=RATE&period=1d&$top=2000&$skip=0&top=0&$select=ID,Name&$filter=((portmfs/Value lt 1))
Extract Inventory and Time-Series Data
The following examples show how to extract trend and time-series data for items with specific configuration details.
Export As-Polled Bits-In and Bits-Out for Interfaces in a Group
You want to extract key interface monitoring data from the Boston group to use in a new visualization. You want to extract one week of as polled data.
To get the as polled data for a week, set the maximum number of expanded rows to the correct value. For this example, the poll interval is 5 minutes, so 2016 data point is one week of data.
To get this data, use the following tokens to build the query:
  • for: interface
  • select: name
  • expand metrics: portmfs: im_BitsIn, im_BitsOut
  • filter: groups/Name equal Boston
  • time range: Last7Days/As polled
  • limit: Maximum number of expanded rows: 2016
OpenAPI URL:
http://
da_host
:8581
/odata/api/interfaces?period=1w&resolution=RATE&$top=50&$skip=0&top=2016&$expand=portmfs&$select=Name,portmfs/im_BitsIn,portmfs/im_BitsOut&$filter=((groups/Name eq 'Boston'))
Get Total Hourly Bits-In and Bits-Out for Interfaces Associated to Devices by IP Address Substring
You want to extract key throughput information for interfaces where the parent device IP address begins with 10.251. You want the hourly throughput totals for the month.
For 30 days of hourly data, set the maximum number of expanded rows to 720
To get this data, use the following tokens to build the query:
  • for: interface
  • select: name
  • expand metrics: portmfs: im_BitsIn, im_BitsOut
  • filter: device/PrimaryIPAddress starts with 10.251
  • time range: Last30Days/Hour
  • limit: Maximum number of expanded rows: 720
OpenAPI URL:
http://
da_host
:8581
/odata/api/interfaces?period=1m&resolution=HOUR&$top=50&$skip=0&top=720&$expand=portmfs&$select=Name,portmfs/im_BitsIn,portmfs/im_BitsOut&$filter=((startswith(PrimaryIPAddress, '10.251') eq true))
Get Total Daily Bits-In & Bits-Out for Interfaces That Have Less Than 1-GB Daily Throughput for the Last 30 Days
You want to identify which interfaces are underutilized.
Because bits in and bits out aggregate by sum, daily resolution provides the same value and the query runs faster.
To get this data, use the following tokens to build the query:
  • for: interface
  • select: name
  • expand metrics: portmfs: im_BitsIn, im_BitsOut
  • filter metrics: portmfs/im_Bits less 1000000000
  • time rang: Last30Days/Day
OpenAPI URL:
http://
da_host
:8581
/odata/api/interfaces?period=1m&resolution=DAY&$expand=portmfs&$select=Name,portmfs/im_BitsIn,portmfs/im_BitsOut&$filter=((portmfs/im_Bits lt 1000000000))
Extract Inventory and Aggregated Values
The following examples show how to extract aggregated data for items with specific configuration details.
The
group aggregate
token applies customizable run-time analytics to the data set.
You cannot mix percentile aggregations with other aggregation types.
Show Me the 95th Percentile Utilization Value for Each Interface in a Group for the Last Seven Days
You want the 95th percentile of utilization for each interface in the Boston group.
To get this data, use the following tokens to build the query:
  • for: interface
  • select: name
  • expand metrics: portmfs: im_Utilization
  • group aggregate:
    • Group By: portmfs, ID
    • Add an Aggregation Function:
      Percentile95
       
      im_Utilization
  • filter: groups/Name equal Boston
  • time range: Last7Days/As polled
OpenAPI URL:
http://
da_host
:8581/odata/api/interfaces?$apply=groupby(portmfs/ID, aggregate(portmfs(im_Utilization with percentile95 as Value)))&resolution=RATE&period=1w&$expand=portmfs&$select=Name,portmfs/ID&$filter=((groups/Name eq 'Boston'))
Show Me the Average CPU Utilization for Each Device in a Group for the Last 30 Days
You want to the average CPU utilization for routers in the Boston group
To get this data, use the following tokens to build the query:
  • for: device
  • select: name
  • group aggregate:
    • Group By: cpumfs, ID
    • Add an Aggregation Function:
      AverageOf
      im_Utilization
  • filter: groups/Name equal Boston
  • time range: Last30Days/As polled
OpenAPI URL:
http://
da_host
:8581
/odata/api/devices?$apply=groupby(cpumfs/ID, aggregate(cpumfs(im_Utilization with average as Value)))&period=1m&resolution=RATE&$select=Name&$filter=((groups/Name eq 'Boston'))
Show Me the Interfaces in a Group That Have Averaged Less Than 40 Percent Hourly Utilization
You want to see which interfaces in your network were underutilized during the last quarter.
To get this data, use the following tokens to build the query:
  • for: interface
  • select: name
  • expand metrics: portmfs: im_utilization
  • group/aggregate
    • Group By: portmfs, ID
    • Add an Aggregation Function:
      AverageOf
      im_utilization
  • filter metrics: portmfs/Value less 40
  • time range: Last3Months/Hour
OpenAPI URL:
http://
da_host
:8581
/odata/api/interfaces?$apply=groupby(portmfs/ID, aggregate(portmfs(im_Utilization with average as Value)))&period=3m&resolution=HOUR&$expand=portmfs&$select=Name,portmfs/im_Utilization&$filter=((portmfs/Value lt 40))
Show Me the Devices with Average CPU and Memory Utilization More Than 75 Percent Based on IP Address Substring
You want to see devices in the subnet starting with 10.251 that have high CPU and memory utilization.
To get this data, use the following tokens to build the query:
  • for: device
  • select: Name
  • expand metrics: cpumfs: im_MemoryUtilization, im_Utilization
  • filter metrics: cpumfs/im_MemoryUtilization greater 75 OR cpumfs/im_Utilization greater 75
  • filter: PrimaryIPAddress starts with 10.251
OpenAPI URL:
http://
da_host
:8581
/odata/api/devices?$expand=cpumfs&$select=Name,cpumfs/im_MemoryUtilization,cpumfs/im_Utilization&$filter=((cpumfs/im_MemoryUtilization gt 75) or (cpumfs/im_Utilization gt 75)) and ((startswith(PrimaryIPAddress, '10.251') eq true))
Extract Metrics Aggregated at the Group Level
The following examples show how to extract metrics aggregated at the group level. Use these queries to understand capacity that is related to the logical groupings of resources. For example, by customers, geography, services, or other.
In large systems, some queries might time out if the filters are applied inefficiently. OpenAPI evaluates filter expressions in the order they appear in the query. Use the filter that limits the data more first. For example, if you want all groups where interface utilization is greater than 50 percent in North America, place the North America filter first.
Show Me the Top Ten Interfaces in Group ID 10 with the Highest Bandwidth Utilization
You want to see the top ten interfaces in Group ID 10 with the highest bandwidth utilization.
To get this data, use the following tokens to build the query:
  • for: portmf
  • select: ID, im_utilization
  • expand: interface/Name
  • filter: groups/ID equal 10
  • sort: im_Utilization (DESC)
  • limit(top): top=10, skip=0, expandtop=10
OpenAPI URL:
 http://
da_host
:8581 /odata/api/portmfs?$orderby=im_Utilization desc&$top=10&$skip=0&top=10&$expand=interface&$select=ID,im_Utilization,interface/Name&$filter=((groups/ID eq 10))
Show Me the Average Interface Utilization of Each Interface in Group ID 10
You want to know the average interface utilization of each interface in Group ID 10.
The following query works best for a small group because paging on aggregated values is unsupported.
To get this data, use the following tokens to build the query:
  • for: group
  • group/aggregate: groupby(portmfs/ID, aggregate(portmfs(im_utilization with average as Value)))
  • expand: interfaces/ID, interfaces/Name
  • select: ID, Name, Description
      Note:
    Value is selected by default on the server side.
  • filter: ID equal 10
OpenAPI URL:
 http://
da_host
:8581 /odata/api/groups?$apply=groupby(portmfs/ID, aggregate(portmfs(im_Utilization with average as Value)))&$expand=interfaces&$select=ID,Name,Description,interfaces/ID,interfaces/Name&$filter=((ID eq 10))
Show Me the Average Interface Utilization for All Interfaces Within Group ID 10 and Group ID 11
You want to know the average interface utilization for all interfaces within Group ID 10 and Group ID 11.
The following query works best for small groups because paging on aggregated values is unsupported.
To get this data, use the following tokens to build the query:
  • for: group
  • group/aggregate: groupby(portmfs/ID, aggregate(portms(im_Utilization with average as Value)))
  • select: ID, Name
      is selected by default on the server side.
  • filter: (ID equal 10) or (ID equal 11)
OpenAPI URL:
 http://
da_host
:8581 /odata/api/groups?$apply=groupby(portmfs/ID, aggregate(portmfs(im_Utilization with average as Value)))&$select=ID,Name&$filter=((ID eq 10) or (ID eq 11))
Show Me the Maximum Interface Utilization Value for Each Child Group Within the Boston Group
You want to know the maximum interface utilization value for each child group within the Boston group.
To get this data, use the following tokens to build the query:
  • for: group
  • group/aggregate: groupby(portmfs/ID, aggregate(portms(im_Utilization with max as Value)))
  • select: ID, Name
      is selected by default on the server side.
  • filter (GroupPathLocation contains Boston)
OpenAPI URL:
 http://
da_host
:8581 /odata/api/groups?$apply=groupby(portmfs/ID, aggregate(portmfs(im_Utilization with max as Value)))&$select=ID,Name&$filter=((substringof('Boston:', GroupPathLocation) eq true))
Show Me the 95th Percentile of Interface Utilization for Each Group That Has the Word "Boston" in the Description
You want to know the 95th percentile of interface utilization for each group with the word "Boston" in the Description.
To get this data, use the following tokens to build the query:
  • for: group
  • group/aggregate: groupby(portmfs/ID, aggregate(portms(im_Utilization with percentile95 as Value)))
  • select: ID, Name
      is selected by default on the server side.
  • filter (Name contains Boston)
OpenAPI URL:
 http://
da_host
:8581 /odata/api/groups?$apply=groupby(ID, aggregate(portmfs(im_Utilization with percentile95 as Value)))&$select=ID,Name&$filter=((substringof('Boston',Name) eq true))
Show Me the Top Five Group IDs with the Highest Group Interface Utilization for All Child Groups in the Boston Group
You want to see the top five groups with the highest group interface utilization for all child groups in the Boston group.
To get this data, use the following tokens to build the query:
  • for: portmf
  • group/aggregate: groupby(groups/ID,aggregate(im_Utilization with average as Value))
  • filter: (groups/GroupPathLocation contains Boston) and (Value greater than or equal 0)
  • select: ID, Value
  • sort: Ordering, Value (DESC)
OpenAPI URL:
 http://
da_host
:8581 /odata/api/portmfs?$apply=groupby(groups/ID, aggregate(im_Utilization with average as Value))&$orderby=Value desc&$select=ID,Value&$filter=((substringof('Boston:',groups/GroupPathLocation) eq true) and (Value ge 0))
Extract Metrics within Specified Business Hours
The following examples show how to extract metrics within specified business hours. For more information see, Advanced OpenAPI Query Examples.
Show Me Data for Monday through Friday 9:00 AM to 5:00 PM Eastern Standard Time (EST)
You want to see data within your business hours, which are Monday through Friday 9:00 AM to 5:00 PM EST.
  • for: group
  • group/aggregate: groupby(portmfs/ID, aggregate(portms(im_Utilization with average as Value)))
  • time range: Last 7 Days/As polled/-05/Mon,Tue,Wed,Thu,Fri 9:00-17:00
  • select: ID, Name
OpenAPI URL: 
http://
da_host
:8581/odata/api/groups?$apply=groupby
(portmfs/ID, aggregate(portmfs(im_Utilization with average as Value)))&resolution=RATE&period=1w&bh=Mon-Fri 9:00-17:00&tz=-05&$select=ID,Name
Show Me Data for Monday, Tuesday, and Friday 9:00 AM to 12:00 PM and 1:00 PM to 6:00 PM
You want to see data within your business hours, which are Monday, Tuesday, and Friday 9:00 AM to 12:00 PM and 1:00 PM to 6:00 PM.
  • for: group
  • group/aggregate: groupby(portmfs/ID, aggregate(portms(im_Utilization with average as Value)))
  • time range: Last 7 Days/As polled/Mon,Tue,Fri 9:00-12:00 13:00-18:00
  • select: ID, Name
OpenAPI URL: 
http://
da_host
:8581/odata/api/groups?$apply=groupby(portmfs/ID, aggregate(portmfs(im_Utilization with average as Value)))&resolution=RATE&period=1w&bh=Mon-Tue 9:00-12:00 13:00-18:00,Fri 9:00-12:00 13:00-18:00&$select=ID,Name
Show Me Data for Monday through Friday 8:00 PM to 4:00 AM
You want to see data within your business hours, which are Monday through Friday 8:00 PM to 4:00 AM.
  • for: group
  • group/aggregate: groupby(portmfs/ID, aggregate(portms(im_Utilization with average as Value)))
  • time range: Last 7 Days/As polled/Mon,Tue,Wed,Thur,Fri 20:00-4:00
  • select: ID, Name
OpenAPI URL: 
http://
da_host
:8581/
odata/api/groups?$apply=groupby(portmfs/ID, aggregate(portmfs(im_Utilization with average as Value)))&resolution=RATE&period=1w&bh=Mon-Fri 20:00-4:00&$select=ID,Name
Show Me Data for Monday through Friday 9:00 AM to 5:00 PM in January
You want to see data for January within your business hours, which are Monday through Friday 9:00 AM to 5:00 PM.
  • for: group
  • group/aggregate: groupby(portmfs/ID, aggregate(portms(im_Utilization with average as Value)))
  • time range: 2017-01-02T09:00~2017-01-31T17:00/As polled/Mon,Tue,Wed,Thu,Fri 9:00-17:00
  • select: ID, Name
OpenAPI URL: 
http://
da_host
:8581/odata/api/groups?$apply=groupby(portmfs/ID, aggregate(portmfs(im_Utilization with average as Value)))&resolution=RATE&starttime=1483365600&endtime=1485900000&bh=Mon-Fri 9:00-17:00&$select=ID,Name
Extract SD-WAN Data
The following examples show how to extract SD-WAN data.
Show Me All Tunnels and Attributes in a Group
You want to see data for your SD-WAN tunnels.
  • for: sdntunnel
  • filter: groups/Name contains Site 1
OpenAPI URL: http://
da_host
:8581/odata/api/sdntunnels?$filter=((substringof('Site 1', groups/Name) eq true))
Show Me the Latency, Loss, and Jitter Values for All Tunnels in a Group
You want to see the latency, loss, and jitter values for your SD-WAN tunnels.
  • for: sdntunnel
  • filter: groups/Name contains Site 1
  • expand metrics: sdntunnelmfs(im_Jitter,im_Latency,im_PacketLossPercentage)
OpenAPI URL: 
http://
da_host
:8581/odata/api/sdntunnels?$expand=sdntunnelmfs&$select=sdntunnelmfs/std_im_Jitter,sdntunnelmfs/std_im_Latency,sdntunnelmfs/std_im_PacketLossPercentage&$filter=((substringof('Site 1', groups/Name) eq true))
Show Me the System Metrics for the Source and Destination Devices for All Tunnels in a Group
You want to see the system metrics for your source and destination devices.
  • for: sdntunnel
  • filter: groups/Name contains Site 1
  • expand metrics: sdntunnelmfs(std_im_Jitter,std_im_Latency,std_im_PacketLossPercentage)
OpenAPI URL: 
http://
da_host
:8581/odata/api/sdntunnels?$expand=sdntunnelmfs&$select=sdntunnelmfs/std_im_Jitter,sdntunnelmfs/std_im_Latency,sdntunnelmfs/std_im_PacketLossPercentage&$filter=((substringof('Site 1', groups/Name) eq true))
Show Me the Virtual Interface Metrics for the Source and Destination Interfaces in a Group
You want to see the virtual interface metrics for your source and destination interfaces.
  • for: sdnvirtualinterface
  • filter: groups/Name contains Site 1
  • expand metrics: stdvitualinterface(std_im_BitsIn,std_im_BitsOut)
OpenAPI URL: 
http://
da_host
:8581/
odata/api/adnvirtualinterfaces?$expand=virtualinterfacemfs&$select=virtualinterfacemfs/std_im_BitsIn,virtualinterfacemfs/std_im_BitsOut&$filter=((substringof('Site 1', groups/Name) eq true))