piwik-8.x-1.4/config/schema/piwik.schema.yml

# Schema for the configuration files of the piwik module.

piwik.settings:
  type: config_object
  label: 'Piwik settings'
  mapping:
    site_id:
      type: string
      label: 'Piwik site ID'
    url_http:
      type: string
      label: 'Piwik HTTP URL'
    url_https:
      type: string
      label: 'Piwik HTTPS URL'
    domain_mode:
      type: integer
      label: 'What are you tracking?'
    visibility:
      type: mapping
      label: 'Visibility'
      mapping:
        request_path_mode:
          type: integer
          label: 'Add tracking to specific pages'
        request_path_pages:
          type: string
          label: 'Pages by their paths'
        user_role_mode:
          type: integer
          label: 'Add tracking for specific roles'
        user_role_roles:
          type: sequence
          label: 'Roles'
          sequence:
            type: string
            label: 'Role'
        user_account_mode:
          type: integer
          label: 'Allow users to customize tracking on their account page'
    track:
      type: mapping
      label: 'Links and downloads'
      mapping:
        mailto:
          type: boolean
          label: 'Track clicks on mailto links'
        files:
          type: boolean
          label: 'Track downloads'
        files_extensions:
          type: string
          label: 'File extension list'
        colorbox:
          type: boolean
          label: 'Track content in colorbox modal dialogs'
        userid:
          type: boolean
          label: 'Track User ID'
        messages:
          type: sequence
          label: 'Track messages of type'
          sequence:
            type: string
            label: 'Message type'
        site_search:
          type: boolean
          label: 'Track internal search'
    privacy:
      type: mapping
      label: 'Privacy'
      mapping:
        donottrack:
          type: boolean
          label: 'Universal web tracking opt-out'
    custom:
      type: mapping
      label: 'Custom variables'
      mapping:
        variable:
          type: sequence
          label: 'Custom variable'
          sequence:
            type: mapping
            label: 'Variable'
            mapping:
              slot:
                type: integer
                label: 'Slot number'
              name:
                type: string
                label: 'The custom variable name.'
              value:
                type: string
                label: 'The custom variable value.'
              scope:
                type: string
                label: 'The scope for the custom variable.'
    codesnippet:
      type: mapping
      label: 'Custom code snippets'
      mapping:
        before:
          type: string
          label: 'Code snippet (before)'
        after:
          type: string
          label: 'Code snippet (after)'
    translation_set:
      type: boolean
      label: 'Track translation sets as one unit'
    cache:
      type: boolean
      label: 'Locally cache tracking code file'
    page_title_hierarchy:
      type: boolean
      label: 'Show page titles as hierarchy like breadcrumbs'
    page_title_hierarchy_exclude_home:
      type: boolean
      label: 'Hide home page from hierarchy'