Configuration reference

Every WebAnalytics option, plus how server configuration and Umbraco-stored settings take precedence over each other.

Configuration lifecycle and precedence

Server configuration supplies the non-secret values until an administrator first saves Settings → Web Analytics. After that save, the settings stored in Umbraco take over.

1. At startup, the package reads WebAnalytics server configuration.
2. Until an administrator saves Settings → Web Analytics, those non-secret values are the active configuration.
3. After the first settings save, non-secret connection settings are stored in Umbraco and become the source of truth.
4. Provider credentials always remain in server-side configuration. A connection-specific credential overrides the shared provider credential.

Each Umbraco application instance keeps its own in-memory report cache. Restart every instance after changing saved settings or credentials, otherwise processes disagree about the configuration.

Configuration-only example

Bootstrap connections this way when deployment automation has to create them. Keep access tokens out of this file.

{
  "WebAnalytics": {
    "Enabled": true,
    "DefaultRangeDays": 30,
    "CacheDuration": "00:05:00",
    "Connections": [
      {
        "Key": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
        "Provider": "Vercel",
        "ProjectId": "prj_...",
        "Team": "team_...",
        "DocumentRootKeys": [
          "11111111-1111-1111-1111-111111111111"
        ],
        "EnableAllDocumentTypes": false,
        "EnabledDocumentTypeKeys": [
          "22222222-2222-2222-2222-222222222222"
        ]
      }
    ]
  }
}

For Plausible, use "Provider": "Plausible" and set SiteId instead of ProjectId and Team. Add EventPropertyNames for custom event properties.

Package settings

Connection settings