Overview: Query Builder for Matomo (Dimension Report)
HOW TO
How to access the Query Builder for Matomo (Dimension Report)
Navigate to Metrics > Query Builder to access the Query Builder. Click the green + New Custom Metric button and select your connected Matomo Account from the Data Source drop-down list. Select the Dimension Report radio button.
-
Query Builder is available on the Professional and Performer plans. Request a trial of Query Builder by following
these steps.
How to use the Query Builder for Matomo (Dimension Report)
Data Source: This is the Matomo Data Source that the Custom Metric is syncing data from.
Pro Tip: Add the word "by" in between the Metric and Dimension in order to determine an appropriate Custom Metric Name. From the Metric and Dimension examples outlined above, we could create the Custom Metrics "Visits by Country," "Total Searches by Device Type," or "Clicks by Channel Type."
If the data synced from the Metric and Dimension fields meet the Segment's specifications, the data is retained and included in the Custom Metric value. If the data synced from the Metric and Dimension fields don't meet the Segment specifications, the data is excluded from the Custom Metric value.
Pro Tip : If you don't know which segments to put in place for your use case, use the Dimension + Data Preview to troubleshoot and get more insight into the data that is returned from your Matomo Account for each field. Learn more here.
Custom Metric Name: Enter a name for your Custom Metric. This Custom Metric name will be available in the Designer after saving.
How to create a Custom Matomo Dimension Report Metric [Example]
In this example, we'll create a Custom Metric to report on Visits tracked in the Matomo Account, split up based on Country.
How to add a Custom Matomo Dimension Report Metric to a Databoard
Learn how to add a Custom Metric to a Databoard here.
Additional Information
- The Data Preview is limited to display a maximum of 20 Dimensions per Date Range for Attributed Metrics. Dimensions will be sorted by descending value, therefore the 20 Dimensions with the highest total values will be displayed in the Data Preview for each Date Range.
- With this Query Builder, we are able to pull data for Attributed Metrics "Unique Visitors" via the API. However, this Metric is not able in Matomo UI which means that the values are not visible in your Matomo Account.