WidgetMetricInfoDto

Article summary

Did you find this summary helpful?

Thank you for your feedback

Available in Classic

This is the metric information in a widget.

Syntax

The syntax is as follows.

private String displayName;
private String prodKey;
private String prodName;
private String metric;
private Map<String, String> dimensions;
private Calculation statistic;
private Interval period;
private String color;
private JSONArray data;

Field

The following describes the fields.

Field	Type	Required	Description
`displayName`	String	-	Name of metric displayed in widget
`prodKey`	String	-	cw_key of the product
`prodName`	String	-	Name of product
`metric`	String	-	Metric name to be searched
`dimensions`	Map<String, String>	-	Dimension name of the data to query Can be entered as a key/value
`statistic`	Calculation	-	Aggregation function to query `COUNT` \| `SUM` \| `MAX` \| `MIN` \| `AVG`
`period`	Interval	-	Aggregation interval to query `Min1` \| `Min5` \| `Min30` \| `Hour2` \| `Day1`
`color`	String	-	Color of the chart displayed in the widget
`data`	JSONArray	-	Search results

Was this article helpful?

What's Next

List Price Overview

Table of contents

Syntax
Field