All Collections
Data Model Administration
Metrics & Templated SQL Commands
Metrics & Templated SQL Commands

How to define and create metrics in the Report Engine

Ed Campbell avatar
Written by Ed Campbell
Updated over a week ago

Metrics are how you measure your data and are used to assess the performance of your marketing or business activity.

  • To create a new metric, go to 'metrics', click on the ellipsis (3 vertical dots) beside any folder and select 'Create Metric'

  • Name your new metric and click the 'Enter' key

Metric Definition

Here you will define how your metric will be calculated using either 'Definitions from template' which includes predetermine SQL queries for easy use (i.e. SUM, COUNT, AVERAGE, etc.) or 'Custom Definition' for basic custom SQL queries.

  • To begin, select which type of definition you want to use +

'Definition from template'

The templated definition allows you to pick from a number of aggregate functions including:


The arithmetic total of all values in the column


The total number of elements in the column

Count Distinct

the number of distinct values across the column

Numerical Average

the mean average of the elements in the column

Numerical Min

the smallest-value element in the column

Numerical Max

the largest-value element in the column

Select the aggregate function from the list and choose the specific fields in your data source that you are interested in. Then click 'Save changes'.

This metric for example is getting the total number of clicks from Facebook.

  • Once you have clicked 'Save Changes' you'll be navigated to the new definition you have just created

  • Within 'Settings' you can alter the 'Prefix', 'Suffix', 'Round', 'Bias', 'Icon Class' & 'Colour' for your new metric

  • Click 'Review and Save'

  • A pop-up box will appear with a review on what has been edited and then you can 'Save changes'

  • If you click 'Save & force report refresh', users who are currently viewing the affected reports will see the report refresh immediately.

'Custom Definition'

Custom definition allows you to input basic SQL queries directly into the new definition template i.e. SUM(IF(query))

  • Selecting the '+' will allow you to add either fields to the query or metrics to create a composite metric

  • You can create varying queries with differing calculations before following the same save procedure outlined in the 'Definition from template' breakdown

Adding more than one definition

You can add more than one metric definition into the report engine for your metric. This is often done when you have two data sources with the same data but at a more granular level. If you have more than one metric definition, the order of the metric definitions is important.

The report engine will automatically take the first metric definition unless the report contains an incompatible dimension so that it cannot use the first definition. In this instance the second definition specified will be used.

For more information on alternative metric definitions please follow the link.

How do I know which data sources are compatible with my metric?

Once you have created your metric a list of compatible data source Ids and names will appear under your metric definition. This will help help you identify which data sources are compatible with your metric.

Did this answer your question?