# Configuration: Matomo Matomo Custom Dimensions Configuration ## Documentation A custom dimension slot configured on a site - up to five per scope, per Matomo's own free-edition cap. The value ValuesByDimension.id_dimension refers to. - Catalog: `Matomo` - Schema: `CustomDimensions` - Primary Keys: `idcustomdimension` - Label: Matomo Custom Dimensions Configuration - Retrieve: True - Insert: True - Update: False - Delete: False ## Parameters of Table Function The following parameters can be used to control the behaviour of the table function `Configuration`. 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 | |---|:---:|:---:|:---:|---| | `id_site` | `number` | ☑ | | The Matomo site ID to list configured custom dimensions of. | ## Columns of Table Function The columns of the table function `Configuration` are shown below. Each column has an SQL data type. A new non-null value must be provided for every required column at all times during insert. | Name | Data Type | Label | Required | Documentation | |---|:---:|---|:---:|---| | `active` | `char` | | ☑ | Whether the dimension is active. A deactivated dimension still occupies its own slot - verified 2026-08-28, Matomo has no way to free a slot once used. | | `case_sensitive` | `char` | | ☑ | Whether extraction pattern matching is case-sensitive. Matomo's own parameter is 'caseSensitive'. | | `description` | `varchar2` | | ☐ | Dimension description. Matomo answers an empty string rather than null when none is set. | | `extractions` | `varchar2` | | ☐ | Extraction rules deriving this dimension's value from a URL or another Matomo value, as JSON text - empty when none are configured. Read-only for now, see the remark above. | | `idcustomdimension` | `int32` | | ☑ | Dimension ID, assigned by Matomo on insert - a slot number scoped to (idsite, scope), not globally unique. Never written. | | `idsite` | `int32` | | ☑ | Site ID the dimension is configured on. Matomo's own configureNewCustomDimension() takes it as 'idSite'. | | `index` | `int32` | | ☑ | Slot number within (idsite, scope) - 1 through 5 on the free edition. Assigned by Matomo on insert, never written. | | `name` | `varchar2` | | ☑ | Dimension name, shown throughout Matomo's own reporting UI. | | `scope` | `varchar2` | | ☑ | Where this dimension is captured: 'visit' or 'action'. Set on insert; configureExistingCustomDimension has no parameter to change it afterwards. |