Linking to a Custom Metric Graph

To open an Oracle Communications Unified Assurance metric graph directly without navigating through the Devices interface or a dashboard, you can make URL calls to the performanceData endpoint with different input options. You can specify multiple inputs in a single call to show specific information.

Accepted Inputs

The following table describes the input options that you can include in performanceData calls. Input names are case-sensitive. The DeviceID and MetricID inputs are always required. All others are optional and use default values if you do not include them.

Name Description Required Default Value
DeviceID The device ID for the metric to display. You can also provide multiple device IDs in a comma-separated list.
To display multiple metrics from different devices on a single graph, you must send the device IDs in an order that correlates to the specified metric IDs.		 Required No default. You must provide a value.
MetricID The ID of the metric to display. You can also provide multiple metric IDs in a comma-separated list.
To display multiple metrics from different devices on a single graph, you must send the device IDs in an order that correlates to the specified Metric IDs.		 Required No default. You must provide a value.
Period The period of data to display.
Allowed values are Daily, Weekly, Monthly, or Yearly.		 Optional Daily
StartTime The starting point of data to display.
Allowed formats are:
  • yyyy-mm-dd: Date only, with time automatically set to midnight.
  • yyyy-mm-ddTHH%3AMM%3ASS: The URL-encoded format for date-time with the T separator (yyyy-mm-ddTHH:MM:SS).
  • yyyy-mm-dd%20HH%3AMM%3ASS: The URL-encoded format for date-time without the T separator (yyyy-mm-dd HH:MM:SS).
 Optional
  • Defaults to now - duration, where the duration is determined by the value of Period.
  • If StartTime is not provided but StopTime is, StartTime defaults to StopTime - duration.
    For example, if StopTime is set to 2024-12-31T02%3A00%3A00 and Period is set to Daily, StartTime defaults to 2024-12-30T02%3A00%3A00 (2024-12-31T02:00:00 - 24h).
StopTime The ending point of data to be displayed.
Allowed formats are:
  • yyyy-mm-dd: Date only, with time automatically set to midnight.
  • yyyy-mm-ddTHH%3AMM%3ASS: The URL-encoded format for date-time with the T separator (yyyy-mm-ddTHH:MM:SS).
  • yyyy-mm-dd%20HH%3AMM%3ASS: The URL-encoded format for date-time without the T separator (yyyy-mm-dd HH:MM:SS).
 Optional
  • Defaults to now.
  • If StopTime is not provided but StartTime is, StopTime defaults to StartTime + duration, where the duration is determined by the value of Period.
    For example, if StartTime is set to 2024-12-30T02%3A00%3A00 and Period is set to Daily, StopTime defaults to 2024-12-31T02%3A00%3A00 (2024-12-30T02:00:00 + 24h).
ShowMetricGroup Whether or not to include the other metrics that are in the same metric group and on the same instance. Allowed values are 0 for false or 1 for true. Optional 0
GraphTitle The text string to display in the title bar. The default is updated dynamically based on the specified metrics and devices, but you can use a custom string instead. Optional
  • For a single metric: <Metric Type> (<Device Name>).
    For example, Disk Used (Device 12345).
  • For multiple metrics from a single device: Mixed Metrics (<Device Name>)
  • For multiple metrics from multiple devices: Mixed Metrics.
AbnormalThreshold Whether or not to show abnormal threshold lines. Allowed values are 0 for false or 1 for true. Optional 0
ThresholdLines Whether or not to show regular threshold lines. Allowed values are 0 for false or 1 for true.
If set to 1, the FullScale input defaults to 1 as well. In the UI, the FullScale option is controlled by the 100% button.		 Optional 0
Trend Whether or not to show trend lines. Allowed values are 0 for false or 1 for true. Optional 0
Stack How to stack the metrics on top of one another. Allowed values are:
  • All
  • Device
  • Instance
  • MetricGroup
  • MetricType
  • None
 Optional MetricGroup
ConnectMissing Whether or not to draw a full line in the graph when data points are missing. Allowed values are 0 for false or 1 for true. Optional 0
FullScale Whether or not to use the 100% view functionality, which adjusts the Y-axis to show the full range of possible data. Only works for metrics that have a maximum value set. Allowed values are 0 for false or 1 for true. Optional
  • 0 if ThresholdLines is set to 0 or unset.
  • 1 if ThresholdLines is set to 1.
Logarithmic Whether or not to use the logarithmic view functionality, which changes the Y-axis from a linear scale to a logarithmic scale. Allowed values are 0 for false or 1 for true. Optional 0

Example URL Calls

The table below shows example URL calls with sample device and metric IDs. Actual device and metric IDs vary from installation to installation.

The sample IDs in the examples are:

Use Case Inputs URL Call
A single metric DeviceID, MetricID https://<WebFQDN>/#/metric/performanceData?DeviceID=1&MetricID=39
Two metrics from the same device DeviceID, MetricID https://<WebFQDN>/#/metric/performanceData?DeviceID=1&MetricID=39,140
Two metrics from two different devices.
The order determines which metric shows for which device. In this use case, metric 39 shows for device 1, and metric 43 shows for device 2.		 DeviceID, MetricID https://<WebFQDN>/#/metric/performanceData?DeviceID=1,2&MetricID=39,43
Three metrics from two different devices.
The order determines which metric shows for which device. In this use case, metrics 39 and 140 show for device 1, and metric 43 shows for device 2.		 DeviceID, MetricID https://<WebFQDN>/#/metric/performanceData?DeviceID=1,1,2&MetricID=39,140,43
The Weekly period DeviceID, MetricID, Period https://<WebFQDN>/#/metric/performanceData?DeviceID=1&MetricID=39&Period=Weekly
A custom start date. Because Period is unspecified, the default of Daily applies, so the graph includes 24 hours of data. DeviceID, MetricID, StartTime https://<WebFQDN>/#/metric/performanceData?DeviceID=1&MetricID=39&StartTime=2018-06-02
A custom start date with 2 AM time DeviceID, MetricID, StartTime https://<WebFQDN>/#/metric/performanceData?DeviceID=1&MetricID=39&StartTime=2018-06-02%2002%3A00%3A00
A custom stop date DeviceID, MetricID, StopTime https://<WebFQDN>/#/metric/performanceData?DeviceID=1&MetricID=39&StopTime=2018-06-02
A custom stop date with 2 AM time DeviceID, MetricID, StopTime https://<WebFQDN>/#/metric/performanceData?DeviceID=1&MetricID=39&StopTime=2018-06-02%2002%3A00%3A00
A custom start date with 2 AM time and a custom stop date with 3 AM time. The dates are the same, with different hours, so the graph displays one hour of data. DeviceID, MetricID, StartTime, StopTime https://<WebFQDN>/#/metric/performanceData?DeviceID=1&MetricID=39&StartTime=2018-06-02%2002%3A00%3A00&StopTime=2018-06-02%2003%3A00%3A00
A single metric and other metrics that are on the same instance and in the same metric group DeviceID, MetricID, ShowMetricGroup https://<WebFQDN>/#/metric/performanceData?DeviceID=1&MetricID=39&ShowMetricGroup=1
A single metric with a custom graph title DeviceID, MetricID, GraphTitle https://<WebFQDN>/#/metric/performanceData?DeviceID=1&MetricID=39&GraphTitle=Custom%20Title
A single metric with the abnormal threshold line DeviceID, MetricID, AbnormalThreshold https://<WebFQDN>/#/metric/performanceData?DeviceID=1&MetricID=39&AbnormalThreshold=1
A single metric with regular threshold lines DeviceID, MetricID, ThresholdLines https://<WebFQDN>/#/metric/performanceData?DeviceID=1&MetricID=39&ThresholdLines=1
A single metric with trend lines DeviceID, MetricID, Trend https://<WebFQDN>/#/metric/performanceData?DeviceID=1&MetricID=39&Trend=1
A single metric and other metrics in the same metric group, with stacking disabled DeviceID, MetricID, ShowMetricGroup, Stack https://<WebFQDN>/#/metric/performanceData?DeviceID=1&MetricID=142&ShowMetricGroup=1&Stack=None
A single metric with a solid line, despite missing data points DeviceID, MetricID, ConnectMissing https://<WebFQDN>/#/metric/performanceData?DeviceID=1&MetricID=39&ConnectMissing=1
A single metric that shows the full scale DeviceID, MetricID, FullScale https://<WebFQDN>/#/metric/performanceData?DeviceID=1&MetricID=39&FullScale=1
A single metric with a logarithmic graph DeviceID, MetricID, Logarithmic https://<WebFQDN>/#/metric/performanceData?DeviceID=1&MetricID=39&Logarithmic=1