You are here

Home » API reference » Matomo Analytics 8

matomo.schema.yml in Matomo Analytics 8

config/schema/matomo.schema.yml

File

config/schema/matomo.schema.yml
View source 
  1. # Schema for the configuration files of the matomo module.

  2. 

  3. matomo.settings:

  4.   type: config_object

  5.   label: 'Matomo settings'

  6.   mapping:

  7.     site_id:

  8.       type: string

  9.       label: 'Matomo site ID'

  10.     url_http:

  11.       type: string

  12.       label: 'Matomo HTTP URL'

  13.     url_https:

  14.       type: string

  15.       label: 'Matomo HTTPS URL'

  16.     domain_mode:

  17.       type: integer

  18.       label: 'What are you tracking?'

  19.     visibility:

  20.       type: mapping

  21.       label: 'Visibility'

  22.       mapping:

  23.         request_path_mode:

  24.           type: integer

  25.           label: 'Add tracking to specific pages'

  26.         request_path_pages:

  27.           type: string

  28.           label: 'Pages by their paths'

  29.         user_role_mode:

  30.           type: integer

  31.           label: 'Add tracking for specific roles'

  32.         user_role_roles:

  33.           type: sequence

  34.           label: 'Roles'

  35.           sequence:

  36.             type: string

  37.             label: 'Role'

  38.         user_account_mode:

  39.           type: integer

  40.           label: 'Allow users to customize tracking on their account page'

  41.     track:

  42.       type: mapping

  43.       label: 'Links and downloads'

  44.       mapping:

  45.         mailto:

  46.           type: boolean

  47.           label: 'Track clicks on mailto links'

  48.         files:

  49.           type: boolean

  50.           label: 'Track downloads'

  51.         files_extensions:

  52.           type: string

  53.           label: 'File extension list'

  54.         colorbox:

  55.           type: boolean

  56.           label: 'Track content in colorbox modal dialogs'

  57.         userid:

  58.           type: boolean

  59.           label: 'Track User ID'

  60.         messages:

  61.           type: sequence

  62.           label: 'Track messages of type'

  63.           sequence:

  64.             type: string

  65.             label: 'Message type'

  66.         site_search:

  67.           type: boolean

  68.           label: 'Track internal search'

  69.     privacy:

  70.       type: mapping

  71.       label: 'Privacy'

  72.       mapping:

  73.         donottrack:

  74.           type: boolean

  75.           label: 'Universal web tracking opt-out'

  76.         disablecookies:

  77.           type: boolean

  78.           label: 'Disable cookies'

  79.     custom:

  80.       type: mapping

  81.       label: 'Custom variables'

  82.       mapping:

  83.         variable:

  84.           type: sequence

  85.           label: 'Custom variable'

  86.           sequence:

  87.             type: mapping

  88.             label: 'Variable'

  89.             mapping:

  90.               slot:

  91.                 type: integer

  92.                 label: 'Slot number'

  93.               name:

  94.                 type: string

  95.                 label: 'The custom variable name.'

  96.               value:

  97.                 type: string

  98.                 label: 'The custom variable value.'

  99.               scope:

  100.                 type: string

  101.                 label: 'The scope for the custom variable.'

  102.     codesnippet:

  103.       type: mapping

  104.       label: 'Custom code snippets'

  105.       mapping:

  106.         before:

  107.           type: string

  108.           label: 'Code snippet (before)'

  109.         after:

  110.           type: string

  111.           label: 'Code snippet (after)'

  112.     translation_set:

  113.       type: boolean

  114.       label: 'Track translation sets as one unit'

  115.     cache:

  116.       type: boolean

  117.       label: 'Locally cache tracking code file'

  118.     page_title_hierarchy:

  119.       type: boolean

  120.       label: 'Show page titles as hierarchy like breadcrumbs'

  121.     page_title_hierarchy_exclude_home:

  122.       type: boolean

  123.       label: 'Hide home page from hierarchy'