About Custom Metrics
Custom metrics are created within the Dashboard Data section of a dashboard’s settings. Custom metrics are equations which are created, by the user, using math symbols and the metrics of either a single data field or multiple data fields. This is important because you can create a single custom metric that can be used in a widget, which pulls in data from various data fields of the settings of a single dashboard.
Note that custom metrics are not project-wide; they will only be available in the dashboard where you created them and in copies of that dashboard.
Creating a Custom Metric
- Click on the Settings icon.
- Click on the Custom Metrics tab that is on the left side of the settings screen.
- Click Add Custom Metric.
- Click on the left text box to name your custom metric.
- Click on Construct Your Equation to begin to create the equation of your new custom metric.
- At this point you can begin to construct your equation. In most situations, you will want to begin with adding a metric. To do this, click on the blue button that says Add Metric.
- By default, a count metric will automatically be added to your equation. If you wish to use a metric besides count, click on Count to bring up the metric editing menu.
- In the metric editing menu, click on the Metric dropdown box to choose a different metric.
Attention: Do not select Subset Ratio from the Metric dropdown when you create a Custom Metric. Instead, see the linked section in order to add a Subset Ratio Metric.
- If a metric is chosen that requires an additional field, be sure to choose the correct field that you want to be calculated in your new custom metric.
- Continue to construct the custom metric by clicking on the different mathematical symbols and metrics that are needed to create your desired equation.
Qtip: If you see a red triangle with a “!” inside of it, this means that the equation is currently invalid. Check to make sure you do not have unnecessary mathematical symbols or two metrics next to each other that are not separated by a mathematical symbol. Both of these instances could cause the equation to be invalid.
- Click Save when your equation is complete.
Adding a Custom Metric to a Widget
- Click the Edit Page button on the page where you want to add a custom metric to a widget.
- For a widget you want to add a custom metric to, enter the widget editing pane in one of the following manners: either create a new widget or click on the Edit button of a pre-existing widget.
- When you are in the widget editing pane, click the Add Metric button in the metrics section.
- By default, the metric will be count. Click on the Count metric.
- In the dropdown of the different metrics available, all custom metrics are located at the very bottom. Click on the custom metric you want to add to the widget.
- In place of count, you will now see your custom metric. Custom metrics have a “CUSTOM” tag in front of their name in the widget editing pane.
Subset Ratio Metric
If you would like to display a proportion of values in the simple chart or table widget, we recommend that you use the subset ratio metric instead of the custom metric. This metric is especially useful in Brand Experience dashboards, and it can help reduce load times.
Keep in mind that when selecting the numerator and denominator for the ratio, each respective field will be independent. The numerator will represent one count metric, regardless of the denominator you choose (although they can be related), and vice versa. In other words, the subset ratio metric can be thought of as (Item 1 count) / (Item 2 count), where Item 2 does not automatically tie Item 1 to the proportion.
When reporting on imagery attributes in simple charts and tables, the base size needs to be set to the number of people who are aware of the brand. For example, you may want to create a custom metric that takes the number of people who selected a specific brand in an attribute question and divide by the number of respondents aware of the brand. The subset ratio metric makes it easy to calculate this proportion – it’s an out-of-the-box way to select the right numerator and denominator.
Adding a Subset Ratio Metric to a Widget
- Click the Edit Page button on the page where you want to add a subset ratio metric to a widget.
- Either add a new widget or click on the Edit button of a pre-existing widget.
Qtip: The metric setup for the simple chart and simple table will be the same.
- When you are in the widget editing pane, click the Add Metric button in the Metrics section.
- The default metric is count. Click on the Count metric.
- In the dropdown of the different metrics available, choose Subset Ratio.
- Select your Numerator Field.
Qtip: The numerator field should be the present values. In a Brand Experience project, this will be one of the imag questions.
- Choose your Numerator Values.
Qtip: These values will help you visualize the number of people who selected a specific answer choice. In this example, we choose the specific brands we’d like to analyze, Gartells and Jones.
- Select the Denominator Field.
Qtip: The denominator field should be the total values. In a Brand Experience project, this will be the aided question.
- Choose the Denominator Values.
Qtip: These values will help you visualize the number of people who were aware of a specific answer choice. In this example, we choose the same brands as the numerator values, Gartells and Jones.
- Click Done.
Below is a list of widgets that have a metrics field. If a widget has a metrics field, you can add your custom metric to it.
Editing a Custom Metric on a Widget
- Enable editing on your dashboard by selecting Edit Page.
- Enter the widget editing pane where the custom metric you want to edit is located by selecting Edit on the widget.
- Click on the custom metric in the Metrics section of the widget editing pane.
- In the first tab named Source, the label of the metric can be renamed.
- In the second tab named Options, you can change the format and the amount of decimal places used when the metric is displayed in the widget. The three formats are number, percent, and currency.
- In the Filters tab you can add a filter.
Qtip: Please note that custom metric filters, much like regular metric filters, will override both page level filters and widget filters.
- In the Legend Values section of the widget editing pane, you can choose if the metric is a bar or a line, if it is plotted on the primary or secondary axis, and change the label name.