Paragon-neo/100G: Determining API call parameters for CAT metrics

When retrieving data for a CAT metric using the API, it is necessary to specify metric parameters {Name}, {Port}, {MetricType}, {ExtId}. Use of incorrect parameters will result in a failed call.

The simplest way to find these is to perform the required measurements, either manually or by scripting, then manually view the desired metric(s) in CAT.

On the metric of interest, hover the mouse over the test that describes the plot; in the example below this is the P-neo 2Way Avg Time Error (cTE) text:

Open

A popup appears in the white box showing the related parameters: 2Way/PN_D/CTE/-

We can then parse this to identify the required parameters:

“2Way” is the metric {Name}

“PN_D” means the {Port} is (Paragon Neo) D

“CTE” is the {MetricType}

“-” is the {ExtId}, a mandatory field that is usually “-” but can be another value

Note that the {Port} parameter refers to the ‘port’ that CAT allocates to the measurement, it may not represent a physical port on the instrument.

We can then use this in the API Help page, e.g.

Open

Open

which will construct and show the resulting API call and result:

Open