# ValuesByDimension: Matomo Matomo Custom Dimensions Get Custom Dimension ## Documentation Visits over one period broken down by the value of one custom dimension, one row per value seen, for a dimension configured on the site. A dimension ID which does not exist on the site yields an error rather than zero rows. - Catalog: `Matomo` - Schema: `CustomDimensions` - Label: Matomo Custom Dimensions Get Custom Dimension This is a read-only table function. The Matomo API may not support changing the data or the Invantive UniversalSQL driver for Matomo does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the Matomo API. ## Parameters of Table Function The following parameters can be used to control the behaviour of the table function `ValuesByDimension`. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be evaluated using their default values. Value specification by position is done by listing all values from the first to the last needed value. For example: a `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three. Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third. | Name | Data Type | Required | Default Value | Documentation | |---|:---:|:---:|:---:|---| | `date` | `varchar2` | ☑ | | The date the period is anchored on, or a range such as '2026-08-01,2026-08-31'. | | `id_dimension` | `number` | ☑ | | The ID of the custom dimension, as configured on the site in Matomo. | | `id_site` | `number` | ☑ | | The Matomo site ID to report on. | | `period` | `varchar2` | ☑ | | The reporting period: day, week, month, year or range. | ## Columns of Table Function The columns of the table function `ValuesByDimension` are shown below. Each column has an SQL data type. | Name | Data Type | Label | Required | Documentation | |---|:---:|---|:---:|---| | `avg_time_on_site` | `double` | | ☐ | Average visit duration among visits carrying this dimension value, in seconds. | | `bounce_count` | `int32` | | ☐ | Number of visits carrying this dimension value with exactly one action. | | `bounce_rate` | `varchar2` | | ☐ | Bounce rate among visits carrying this dimension value, formatted by Matomo itself as a percentage. | | `label` | `varchar2` | | ☐ | The value this custom dimension carried on the visit(s) counted in this row. | | `max_actions` | `int32` | | ☐ | Maximum number of actions in a single visit carrying this dimension value. | | `nb_actions_per_visit` | `double` | | ☐ | Average number of actions per visit, among visits carrying this dimension value. | | `nb_actions` | `int32` | | ☐ | Number of actions across visits carrying this dimension value. | | `nb_visits_converted` | `int32` | | ☐ | Number of visits carrying this dimension value during which at least one goal was converted. | | `nb_visits` | `int32` | | ☐ | Number of visits carrying this dimension value. | | `segment` | `varchar2` | | ☐ | Matomo's own segment expression selecting exactly this dimension value, usable as the segment argument of another reporting table. | | `sum_daily_nb_uniq_visitors` | `int32` | | ☐ | Sum, over every day in the period, of the number of unique visitors carrying this dimension value that day - not the same as a period-wide unique count, which Matomo does not sum this way across days. | | `sum_daily_nb_users` | `int32` | | ☐ | Sum, over every day in the period, of the number of visits with a User ID set carrying this dimension value that day. | | `sum_visit_length` | `int32` | | ☐ | Sum of the length of visits carrying this dimension value, in seconds. |