Cisco Evolved Programmable Network Manager API
Evolved Programmable Network Manager API Documentation

REST API Resources

BNG IP Pool Statistics

The BNG IP Pool Statistics API provides performance data of Ip Pool. Each REST call contains the URL for the next REST call in the process, so the only method that the user needs to manually compose is the first one - "BNG IP Pool Details". The response will contain the exact URL for the next method ("BNG IP Pool Available Metrics").
  • BNG IP Pool Details
  • BNG IP Pool Available Metrics
  • BNG IP Pool Metric Data
Resource Description
GET BNG IP Pool Available Metrics
Fetches all metrics that are relevant for the specific ip pool, as well as the URL of the next step (BNG IP Pool Metric Data) that is available under the "url" element.
Example: op/statisticsService/me1200qos/metrics?deviceName=ME-1200-1& ifName=GigabitEthernet 1/3.ECE.40&evcId=1&tableName=EVC
GET BNG IP Pool Details
Fetches the BNG IP Pool basic details, in addition to the URL for the next step that is available under the "metricsLink" element.
Examples:
op/statisticsService/bngIp
op/statisticsService/bngIp?.full=true&device=10.56.23.51
GET BNG IP Pool Metric Data
Fetches performance data of a given metric or metrics for a specific ip pool over a given period.
Examples:
op/statisticsService/bngIp/metrics/used?startTime=1499071288516&endTime=1499074888516& metricDataType=TIME_SERIES&device=10.56.23.51&poolName=IPOE
op/statisticsService/bngIp/metrics/used,free?startTime=1499071288516& endTime=1499074888516&metricDataType=TIME_SERIES&device=10.56.23.51&poolName=IPOE

BNG Sessions Statistics

The BNG Sessions Statistics provides performance data of session. Each REST call contains the URL for the next REST call in the process, so the only method that the user needs to manually compose is the first one - "BNG Sessions Details". The response will contain the exact URL for the next method ("BNG Sessions Available Metrics").
  • BNG Sessions Details
  • BNG Sessions Available Metrics
  • BNG Sessions Metric Data
Resource Description
GET BNG Sessions Available Metrics
Fetches all metrics that are relevant for the session, as well as the URL of the next step ("BNG IP Pool Metric Data") that is available under the "url" element.
Example: op/statisticsService/bngIp/metrics?device=10.56.23.51&pointType=physical &sessionType=all
GET BNG Sessions Details
Fetches the BNG Sessions basic details, in addition to the URL for the next step that is available under the "metricsLink" element.
Examples:
op/statisticsService/bngSessions
op/statisticsService/bngSessions?.full=true&device=10.56.23.51
GET BNG Sessions Metric Data
Fetches performance data of a given metric or metrics for a specific session over a given period.
Example: op/statisticsService/bngSessions/metrics/up?pointType=physical& sessionType=all&device=10.56.23.51&metricDataType=TIME_SERIES& startTime=1499054544561&endTime=1499076144561

CEM Statistics

The CEM Statistics API provides performance data of CEM interfaces. Each REST call contains the URL for the next REST call in the process, so the only method that the user needs to manually compose is the first one – “CEM Details”. The response will contain the exact URL for the next method (“CEM Available Metrics”).
  • CEM Details
  • CEM Available Metrics
  • CEM Metric Data
Resource Description
GET CEM Available Metrics
Fetches all metrics that are relevant for a specific interface, as well as the URL of the next step (“Optical SFP Metric Data”) that is available under the "url" element.
Example: op/statisticsService/cem/metrics?deviceName=10.56.23.109& ifName=CEM-PG1&cemId=16001
GET CEM Details
Fetches the CEM interfaces basic details, in addition to the URL for the next step that is available under the "metricsLink" element.
Examples:
op/statisticsService/cem
op/statisticsService/cem?.full=true&device=10.56.23.109
GET CEM Metric Data
Fetches performance data of a given metric or metrics for a specific interface over a given period.
Example: op/statisticsService/cem/metrics/receivedRbits,receivedLbits?startTime=1498996800749& endTime=1499000400749&metricDataType=TIME_SERIES&deviceName=10.56.23.109& ifName=CEM-PG1&cemId=16001
OR TOP N performance data of a given metric for all the CEM interfaces over a given time period.
Example: op/statisticsService/cem/metrics/receivedRbits?startTime=1498996800749& endTime=1499000400749&metricDataType=TOP_N

CLI Template Configuration

The CLI Template Configuration service allows a CLI configuration template to be applied to one or more target devices. It also provides a way to upload, delete, and get the CLI templates in the system.

Resource Description
DELETE Delete Configuration Template Deletes a template from the system.
GET Download Configuration Template
Deprecated

Please use the CLI Configuration Templates resource instead. This operation may be removed in a future release.

Export a template from the system.
GET List Configuration Templates
Deprecated

This operation does not support pagination, filtering, or sorting. Please use the CLI Configuration Templates resource instead. This operation may be removed in a future release.

Get a list of the published Templates
GET List Device Types Returns the list of device types you can specify for a CLI template.
POST Upload Configuration Template Upload a new template into the system. Does not support Converged Access Templates (IOS-XE templates and templates created from them).
PUT Deploy Configuration Template
Deprecated

This resource deploys templates in a synchronized way which may take a long time to respond. Use the resource Deploy Configuration Template Through Job instead

Deploy a template to a list of devices.

Circuit Statistics

The Circuit Statistics provides performance data of circuits. Using a step-by-step process, by providing only the circuit name, user can retrieve performance data for each of the counters available depending on the circuit type. Each rest call contains the url for the next rest call in the process, so the only method that the user needs to manually compose is the first one - Circuit Details. The response will already contain the exact url for the next method (Circuit Available Metrics). Statistics will be available once appropriate monitoring policy is enabled. The order of the rest calls is as follows:
  • Circuit Details
  • Circuit Available Metrics
  • Circuit Metric Data
Resource Description
GET Circuit Available Metrics
Fetches all the counters that are relevant for the circuit type, the counter type, and the url of the next step (Circuit Metric Data) that is available under the "url" element. Example: /op/statisticsService/circuits/metrics?circuitType=EVC&circuitId=16229216
GET Circuit Details
Fetches the circuit basic details, in addition to the url for the next step that is available under the "metricsLink" element. Example: /op/statisticsService/circuits?.full=true&circuitName=EvcLink_EthPwLink%23EPW_50.50.50.50
GET Circuit Links Metrics URLs
Fetches all Links that are relevant for a circuit name, and the url of the next step (Link Metric Data) that is available under the "url" element. Example: /op/statisticsService/circuits/links?circuitName=EvcLink_EthPwLink%23EPW_50.50.50.50
GET Circuit Metric Data
Fetches performance data of a given circuit and counter name. Example: /op/statisticsService/circuits/metrics/Ipslay1731AvgAvailability?maxResults=24&timeInterval=6&circuitType=EVC&circuitId=16229216

Device Sensors Statistics

The Device Sensors Statistics API provides performance data of sensors. Each REST call contains the URL for the next REST call in the process, so the only method that the user needs to manually compose is the first one - "Device Sensors Details". The response will contain the exact URL for the next method ("Device Sensors Available Metrics").
  • Device sensors Details
  • Device sensors Available Metrics
  • Device sensors Metric Data
Resource Description
GET Device Sensors Available Metrics
Fetches all sensors for a specific device, as well as the URL of the next step (“Device Sensors Metric Data”) that is available under the "url" element.
Examples:
op/statisticsService/sensors/metrics?device=10.56.23.63
op/statisticsService/sensors/metrics?device=10.56.23.63&sensorType=Watts
Valid sensor types:
Other, Unknown, VoltsAC, VoltsDC, milliAmps, Watts, Hertz, Celsius, PercentRH, Rpm, Cmm, Truthvalue, SpecialEnum, DBm
GET Device Sensors Details
Fetches the Device sensors basic details, in addition to the URL for the next step that is available under the "metricsLink" element.
Example: op/statisticsService/sensors
GET Device Sensors Metric Data
Fetches up to date sensors performance data for a specific device.
Example:
op/statisticsService/sensors/metrics/sensorValue?metricDataType=TOP_N&device=10.56.23.63

Group Summary Service

The Group Summary Service provides a summary of alarms per group for each type of group (Site, Device Type or User Defined Group) , an overall alarm summary and a summary of the number devices per Site.

Resource Description
GET Alarm Summary Provides alarm summary information including: total number of alarms, number of alarmed devices, number of alarmed sites, number of alarmed APs and number of alarmed Clients.
GET Device Groups Returns list of Device Type groups, including the count of alarms of each severity for each group.
GET Location Groups Returns list of Locations, including the count of alarms of each severity for each group. Also includes counts of devices, APs and Clients associated with the Location and also location information regarding the location. This service was formerly known as "Site Groups."
GET User Defined Groups Returns list of User Defined groups for both Network Device Groups and Port Groups, including the count of alarms of each severity for each group.

IPSLA (ICMP JITTER) Statistics

The IPSLA (ICMP JITTER) Statistics API provides performance data of L3 ICMP Jitter probes. Using a step-by-step process, by providing the device,targetIp and vrfName, the user can retrieve performance data for each of the metrics available. Each REST call contains the URL for the next REST call in the process, so the only method that the user needs to manually compose is the first one – “IPSLA Probe Details”. The response will contain the exact URL for the next method (“IPSLA Available Probe Metrics”).
  • IPSLA (ICMP JITTER) Probe Details
  • IPSLA (ICMP JITTER) Available Probe Metrics
  • IPSLA (ICMP JITTER) Probe Metric Data
Resource Description
GET IPSLA (ICMP JITTER) Available Probe Metrics
Fetches all metrics that are relevant for a specific probe, as well as the URL of the next step (“IPSLA (ICMP JITTER) Probe Metric Data”) that is available under the "url" element.
Example: op/statisticsService/ipsla/metrics?device=10.56.23.49&targetIp=130.1.2.1& vrfName=L3VPN_RK_01&ipslaType=ICMP Echo&tos=0
GET IPSLA (ICMP JITTER) Probe Details
Fetches the IPSLA probes details, in addition to the URL for the next step that is available under the "metricsLink" element.
Example: op/statisticsService/ipsla?.full=true&device=10.56.23.49& targetIp=130.1.2.1&vrfName=L3VPN_RK_01
GET IPSLA (ICMP JITTER) Probe Metric Data
Fetches performance data of a given metric or metrics for a specific probe over a given period.
Examples:
op/statisticsService/ipsla/metrics/jitterforward?startTime=1498991848163& endTime=1498995448163&metricDataType=TIME_SERIES&device=10.56.23.49& targetIp=130.1.2.1&vrfName=L3VPN_RK_01&tos=0

op/statisticsService/ipsla/metrics/stats?metrics=jitterforward,delayForward,lossforward& startTime=1498991848163&endTime=1498995448163&metricDataType=STATS& device=10.56.23.49&targetIp=130.1.2.1&vrfName=L3VPN_RK_01&tos=0

OR TOP N performance data of a given metric for all probes over a given time period.
Example: op/statisticsService/ipsla/metrics/jitterforward?startTime=1498991848163& endTime=1498995448163&metricDataType=TOP_N

IPSLA Y1731 Statistics

The IPSLA Y1731 Statistics API provides performance data of Y.1731 probes. Each REST call contains the URL for the next REST call in the process, so the only method that the user needs to manually compose is the first one - "ISLA Y1731 Probe Details". The response will contain the exact URL for the next method ("IPSLA Y1731 Available Probe Metrics").
  • IPSLA Y1731 Probe Details
  • IPSLA Y1731 Available Probe Metrics
  • IPSLA Y1731 Probe Metric Data
Resource Description
GET IPSLA Y1731 Available Probe Metrics
Fetches all metrics that are relevant for a specific probe, as well as the URL of the next step ("IPSLA Y1731 Probe Metric Data") that is available under the "url" element.
Example: op/statisticsService/y1731/metrics?device=10.56.23.109& sourceMpid=MPID 151&targetMpid=MPID 150&cfmDomain=L5&evc=e713& operationType=Delay
GET IPSLA Y1731 Probe Details
Fetches the IPSLA Y1731 probes details, in addition to the URL for the next step that is available under the "metricsLink" element.
Example: op/statisticsService/y1731
GET IPSLA Y1731 Probe Metric Data
Fetches performance data of a given metric for a specific probe over a given period.
Example: op/statisticsService/y1731/metrics/delayforward?startTime=1498986621324& endTime=1498990221324&metricDataType=TOP_N

OR TIME SERIES performance data of a given metric for all probes over a given time period.
Example: op/statisticsService/y1731/metrics/delayforward?startTime=1498986621324& endTime=1498990221324&metricDataType=TIME_SERIES&device=10.56.23.109& sourceMpid=MPID 151&targetMpid=MPID 150&cfmDomain=L5&evc=e713& operationType=Delay

Interface CRC Errors Statistics

The Interface CRC Statistics API provides performance data of errors. Each REST call contains the URL for the next REST call in the process, so the only method that the user needs to manually compose is the first one – “Interface CRC Details”. The response will contain the exact URL for the next method (“Interface CRC Available Metrics”).
  • Interface CRC Details
  • Interface CRC Available Metrics
  • Interface CRC Metric Data
Resource Description
GET Interface CRC Errors Available Metrics
Fetches all metrics that are relevant for a specific interface, as well as the URL of the next step (“Interface CRC Metric Data”) that is available under the "url" element.
Example: op/statisticsService/interfacecrc/metrics?device=10.56.23.63&ifName=BDI519
GET Interface CRC Errors Details
Fetches the Interface CRC errors basic details, in addition to the URL for the next step that is available under the "metricsLink" element.
Example: op/statisticsService/interfacecrc
GET Interface CRC Errors Metric Data
Fetches performance data of a given metric or metrics for a specific interface over a given period.
Examples:
op/statisticsService/interfacecrc/metrics/crcErrorsCount?startTime=1499153553628& endTime=1499157153628&metricDataType=TIME_SERIES&device=10.56.23.63& ifName=BDI519

op/statisticsService/interfacecrc/metrics/stats?metrics=crcErrorsCount& startTime=1499153553628&endTime=1499157153628&metricDataType=STATS& device=10.56.23.63&ifName=BDI519

OR TOP N performance data of a given metric for all interfaces over a given time period.
Example: op/statisticsService/interfacecrc/metrics/crcErrorsPercentage?startTime=1499153553628& endTime=1499157153628&metricDataType=TOP_N

Manage and Monitor Info Service

The Manage and Monitor Info Service service provides information about the application and the server it runs on.

Resource Description
GET Core Dumps Returns the number of application core dumps present on the server.
GET Disk Usage and Capacity Returns capacity and usage information for the volumes present on the application's server.
GET Licenses Returns license information about the application.
GET Uptime Returns uptime information as well as information about the application and the server it runs on.
GET Version Returns the version of the application.

Me1200 Quality of Service Statistics

The Me1200 Quality of Service Statistics provides performance data of QoS Performance of Interfaces. Each REST call contains the URL for the next REST call in the process, so the only method that the user needs to manually compose is the first one - "Me1200 Quality of Service Details". The response will contain the exact URL for the next method ("Me1200 Quality of Service Available Metrics").
  • Me1200 Quality of Service Details
  • Me1200 Quality of Service Available Metrics
  • Me1200 Quality of Service Metric Data
Resource Description
GET Me1200 Quality of Service Available Metrics
Fetches all metrics that are relevant for the EVC, as well as the URL of the next step (“Me1200 Quality of Service Metric Data”) that is available under the "url" element.
Example: op/statisticsService/me1200qos/metrics?deviceName=ME-1200-1& ifName=GigabitEthernet 1/3.ECE.40&evcId=1&tableName=EVC
GET Me1200 Quality of Service Details
Fetches the Me1200 Quality of Service of EVCs basic details, in addition to the URL for the next step that is available under the "metricsLink" element.
Examples:
op/statisticsService/me1200qos
op/statisticsService/me1200qos?.full=true&device=10.56.23.109
GET Me1200 Quality of Service Metric Data
Fetches performance data of a given metric or metrics for a specific interface and EVC over a given period.
Examples:
op/statisticsService/me1200qos/metrics/stats?metrics=tx_yellow_framerate,rx_yellow_framerate& startTime=1498995959350&endTime=1498999559350&metricDataType=STATS& deviceName=ME-1200-1&ifName=GigabitEthernet 1/3.ECE.40& evcId=1&tableName=EVC

op/statisticsService/me1200qos/metrics/txyellowbitrate,rxyellowbitrate?startTime=1498995959350 &endTime=1498999559350&metricDataType=TIME_SERIES&deviceName=ME-1200-1& ifName=GigabitEthernet 1/3.ECE.40&evcId=1&tableName=EVC

Optical Ethernet Statistics

The optical pm statistics API provides performance data of optical device performance. Each REST call contains the URL for the next REST call in the process.
  • Optical Ethernet Resources
  • Optical Ethernet Metric
  • Optical Ethernet PerformanceData
Resource Description
GET Optical Ethernet Metrics
Fetches the URLs for various metrics of an Interface
Example: statisticsService/opticalethernet/metrics?device=10.56.23.109& ifName=GigabitEthernet0/6&pmInterval=15-MIN&startTime=1498995120297& endTime=1498998320297
GET Optical Ethernet Performance Data
Fetches the metric data for an Interface
Example: op/statisticsService/opticalethernet/metrics/{metrics}?

TIME SERIES performance data of a given metric for all probes over a given time period.
Example: op/statisticsService/opticalphysical/metrics/Voltage,RxPower,Temperature?startTime=1498986621324& endTime=1498990221324&ifName=TIME_SERIES&device=10.56.23.109& pmInterval=1-DAY
GET Optical Ethernet Resources
Fetches the details of Interfaces
Example: op/statisticsService/opticalethernet

Optical OTN Data Statistics

Resource Description
GET Optical OTN Metrics
Fetches the URLs for various metrics of an Interface
Example: statisticsService/opticalotn/metrics?device=10.56.23.109& ifName=GigabitEthernet0/6&pmInterval=15-MIN&startTime=1498995120297& endTime=1498998320297
GET Optical OTN Performance Data
Fetches the metric data for an Interface
Example: op/statisticsService/opticalotn/metrics/{metrics}?

TIME SERIES performance data of a given metric for all probes over a given time period.
Example: op/statisticsService/opticalotn/metrics/Voltage,RxPower,Temperature?startTime=1498986621324& endTime=1498990221324&ifName=TIME_SERIES&device=10.56.23.109& pmInterval=1-DAY
GET Optical OTN Resources
Fetches the details of Interfaces
Example: op/statisticsService/opticalotn

Optical Physical Statistics

The optical pm statistics API provides performance data of optical device performance. Each REST call contains the URL for the next REST call in the process.
  • Optical Physical Resources
  • Optical Physical Metric
  • Optical Physical Performance Data
Resource Description
GET Optical Physical Metrics
Fetches the URLs for various metrics of an Interface
Example: statisticsService/opticalphysical/metrics?device=10.56.23.109& ifName=GigabitEthernet0/6&pmInterval=15-MIN&startTime=1498995120297& endTime=1498998320297
GET Optical Physical Performance Data
Fetches the metric data for an Interface
Example: op/statisticsService/opticalphysical/metrics/{metrics}?

TIME SERIES performance data of a given metric for all probes over a given time period.
Example: op/statisticsService/opticalphysical/metrics/Voltage,RxPower,Temperature?startTime=1498986621324& endTime=1498990221324&ifName=TIME_SERIES&device=10.56.23.109& pmInterval=1-DAY
Example: /webacs/api/v2/op/statisticsService/opticalphysical/metrics/{}
GET Optical Physical Resources
Fetches the details of Interfaces
Example: op/statisticsService/opticalphysical

Optical SFP Statistics

The Optical SFP DOM Statistics API provides performance data of SFP module. Each REST call contains the URL for the next REST call in the process, so the only method that the user needs to manually compose is the first one - "Optical SFP Details". The response will contain the exact URL for the next method ("Optical SFP Available Metrics").
  • Optical SFP Details
  • Optical SFP Available Metrics
  • Optical SFP Metric Data
Resource Description
GET Optical SFP Available Metrics
Fetches all metrics that are relevant for the SFP module, as well as the URL of the next step ("Optical SFP Metric Data") that is available under the "url" element. Example: op/statisticsService/opticalSfp/metrics?device=10.56.23.27&ifName=GigabitEthernet0/6
GET Optical SFP Details
Fetches the Optical SFP module details, in addition to the URL for the next step that is available under the "metricsLink" element.
Examples:
op/statisticsService/opticalSfp
op/statisticsService/opticalSfp?.full=true&device=10.56.23.27
GET Optical SFP Metric Data
Fetches performance data of a given metric or metrics, for a specific interface over a given period.
Examples:
op/statisticsService/opticalSfp/metrics/stats?metrics=Voltage,RxPower,Temperature& startTime=1498995120297&endTime=1498998720297&metricDataType=STATS& device=10.56.23.27&ifName=GigabitEthernet0/6

op/statisticsService/opticalSfp/metrics/Voltage,RxPower,Temperature?startTime=1498995120297& endTime=1498998720297&metricDataType=TIME_SERIES&device=10.56.23.27& ifName=GigabitEthernet0/6

Optical Sonet SDH Statistics

Resource Description
GET Optical Sonet SDH Metrics
Fetches the URLs for various metrics of an Interface
Example: op/statisticsService/opticalsonetsdh/metrics/Voltage,RxPower,Temperature?startTime=1498986621324& endTime=1498990221324&ifName=TIME_SERIES&device=10.56.23.109& pmInterval=1-DAY
GET Optical Sonet SDH Performance Data
Fetches the metric data for an Interface
Example: op/statisticsService/opticalsonetsdh/metrics/{metrics}?

TIME SERIES performance data of a given metric for all probes over a given time period.
Example: op/statisticsService/opticalsonetsdh/metrics/Voltage,RxPower,Temperature?startTime=1498986621324& endTime=1498990221324&ifName=TIME_SERIES&device=10.56.23.109& pmInterval=1-DAY
GET Optical Sonet SDH Resources
Fetches the details of Interfaces
Example: op/statisticsService/opticalsonetsdh

Quality of Service Statistics

The Quality of Service Statistics API provides the QoS Performance of Interfaces, QoS polices and QoS classes. Each REST call contains the URL for the next REST call in the process, so the only method that the user needs to manually compose is the first one - "Quality of Service Policy Details". The response will contain the exact URL for the next method ("Quality of Service Policy Metrics").
  • Quality of Service Policy Details
  • Quality of Service Available Policy Metrics
  • Quality of Service Policy Metric Data
Resource Description
GET Quality of Service Available Policy Metrics
Fetches all metrics that are relevant for a given instance identified by: device, interface Name, policy, classmap and direction, as well as the URL of the next step (“Quality of Service Policy Metric Data”) that is available under the "url" element.
Example: op/statisticsService/qos/metrics?device=10.56.23.25&ifName=GigabitEthernet0/10& policy=testQosDerechoMR3Policy&classmap=testQosDerechoMR3&direction=input
GET Quality of Service Policy Details
Fetches the Quality of Service instances basic details, in addition to the URL for the next step that is available under the "metricsLink" element.
Example: op/statisticsService/qos
GET Quality of Service Policy Metric Data
Fetches performance data of a given metric for specific policy over a given period.
Example: op/statisticsService/qos/metrics/droprate?startTime=1498989265013& endTime=1498992865013&metricDataType=TIME_SERIES&device=10.56.23.25& ifName=GigabitEthernet0/10&policy=testQosDerechoMR3Policy& classmap=testQosDerechoMR3&direction=input

TDM and Sonet Port Statistics

The TDM and Sonet Statistics API provides performance data of SONET and TDM ports (E1, T1, E3, T3, etc..). Each REST call contains the URL for the next REST call in the process, so the only method that the user needs to manually compose is the first one – “TDM and Sonet Port Details”. The response will contain the exact URL for the next method (“TDM and Sonet Available Port Metrics”).
  • TDM and Sonet Port Details
  • TDM and Sonet Available Port Metrics
  • TDM and Sonet Port Metric Data
Resource Description
GET TDM and Sonet Available Port Metrics
Fetches all metrics that are relevant for the TDM and Sonet port, as well as the URL of the next step ("TDM and Sonet Port Metric Data") that is available under the "url" element. Example: op/statisticsService/tdm/PATH/metrics?device=10.56.23.63&ifName=E1 0/3/0
GET TDM and Sonet Port Details
Fetches the TDM and Sonet port details, in addition to the URL for the next step that is available under the "metricsLink" element.
Examples:
op/statisticsService/tdm
op/statisticsService/tdm?.full=true&device=10.56.23.63
GET TDM and Sonet Port Metric Data
Fetches performance data of a given metric, for a specific port over a given period.
Example: op/statisticsService/tdm/PATH/metrics/UASFE?startTime=1498993027544& endTime=1498996627544&metricDataType=TIME_SERIES&device=10.56.23.63& ifName=E1 0/3/0

Y1731 Bins Statistics

The Y1731 Bins Statistics API counts the number of Frame Delay measurements falling within a specified range, over specified measurement intervals. Each REST call contains the URL for the next REST call in the process, so the only method that the user needs to manually compose is the first one - "Y1731 Bins Details". The response will contain the exact URL for the next method ("Y1731 Bins Available Metrics").
  • Y1731 Bins Details
  • Y1731 Bins Available Metrics
  • Y1731 Bins performance Data
Resource Description
GET Y1731 Bins Available Metrics
Fetches all metrics that are relevant for a specific probe, as well as the URL of the next step ("Y1731 Bins performance Data") that is available under the "url" element. Available metrics are: Delay (forward, backward, two way), Jitter (forward, backward, two way)
Example: op/statisticsService/y1731bins/metrics?device=10.56.23.64& sourceMpid=MPID%20134&targetMpid=MPID%20135&cfmDomain=level5&bridgeId=995& ipslaServiceName=level5&operationType=Delay
GET Y1731 Bins Details
Fetches the Y1731 probe details and number of bins, in addition to the URL for the next step that is available under the "metricsLink" element.
Example: op/statisticsService/y1731bins
GET Y1731 Bins performance Data
Fetches performance measurements of a given metric for a specific probe over a given period.
Example: op/statisticsService/y1731bins/metrics/stats?metrics=JitterBck& metricDataType=STATS&device=10.56.23.64&sourceMpid=MPID%20134& targetMpid=MPID%20135&cfmDomain=level5&bridgeId=995&operationType=Delay