Umbraco.Community.GoatCounter
0.0.3
dotnet add package Umbraco.Community.GoatCounter --version 0.0.3
NuGet\Install-Package Umbraco.Community.GoatCounter -Version 0.0.3
<PackageReference Include="Umbraco.Community.GoatCounter" Version="0.0.3" />
<PackageVersion Include="Umbraco.Community.GoatCounter" Version="0.0.3" />
<PackageReference Include="Umbraco.Community.GoatCounter" />
paket add Umbraco.Community.GoatCounter --version 0.0.3
#r "nuget: Umbraco.Community.GoatCounter, 0.0.3"
#:package Umbraco.Community.GoatCounter@0.0.3
#addin nuget:?package=Umbraco.Community.GoatCounter&version=0.0.3
#tool nuget:?package=Umbraco.Community.GoatCounter&version=0.0.3
GoatCounter for Umbraco
GoatCounter is a small, open source, privacy-friendly web analytics service. This package brings it into the Umbraco backoffice, and lets your site count its own page views so blockers don't hide your visitors.
<img alt="The Analytics dashboard in the Content section, showing views per day, most viewed pages and referrers" src="https://github.com/AndyCross/umbraco-goatcounter/raw/main/docs/screenshots/dashboard.png" width="800">
Sample data.
- A dashboard in the Content section: views per day, most viewed pages, referrers, countries, browsers, systems and screen sizes, for the last 7, 30 or 90 days.
- A Views tab on every page, showing how often that page was viewed.
- First-party counting. Page views go to an endpoint on your own site, which passes them to GoatCounter.
Your API keys stay on the server. The browser never talks to GoatCounter.
Umbraco versions supported: 17.x (tested on 17.0.0 and 17.8.1).
Installation
dotnet add package Umbraco.Community.GoatCounter
Installing the package sends nothing. The dashboard appears once Site and Token are set, and counting starts only when CountPageViews is true.
Configuration
"GoatCounter": {
"Site": "mysite",
"Token": "an API key that can read statistics",
"CountToken": "an API key that can record page views",
"CountPageViews": true,
"Hostnames": [ "example.com" ]
}
| Setting | What it does | Default |
|---|---|---|
Site |
Your GoatCounter code (mysite for mysite.goatcounter.com), or the full URL of a self-hosted GoatCounter |
none |
Token |
API key for reading statistics. The dashboard needs it | none |
CountToken |
API key for recording page views. Falls back to Token |
none |
CountPageViews |
Turns first-party counting on | false |
Route |
The path on your site the beacon is sent to | /s |
Hostnames |
Hosts that are counted. Empty means any host except localhost | empty |
CacheMinutes |
How long statistics are kept before GoatCounter is asked again | 5 |
Create API keys in GoatCounter under Settings, API. Keep them out of source control: use user secrets or environment variables (GoatCounter__Token).
Views on every page
Each document gets a Views tab. A page's views are looked up under its URL.
<img alt="The Views tab on a document, showing its views per day and the paths they were counted under" src="https://github.com/AndyCross/umbraco-goatcounter/raw/main/docs/screenshots/document-views.png" width="800">
Sample data.
If a page used to live somewhere else, register an IGoatCounterPathProvider that returns its old paths, and the tab adds them together:
public class OldBlogPaths : IGoatCounterPathProvider
{
public IEnumerable<string> PathsFor(IPublishedContent content)
{
if (content.Value<string>("oldPath") is { Length: > 0 } old) yield return old;
}
}
// in a composer
builder.Services.AddSingleton<IGoatCounterPathProvider, OldBlogPaths>();
Counting page views
Add the beacon to your layout's <head>:
@using GoatCounter
@Html.GoatCounterBeacon()
The page asks your own site for a tiny image at /s. The site answers at once, queues the view, and passes it to GoatCounter's API in a batch with your API key.
- The visitor's browser only ever talks to your site, so blockers that know
gc.zgo.atand*.goatcounter.comhave nothing to block. - Your site answers straight away and sends views on in batches, so a page view never waits on GoatCounter.
- The beacon writes nothing on hosts you don't count, so development and staging sites stay silent.
- Views waiting to be sent are held in memory. A restart loses the last couple of seconds' worth.
GoatCounter uses the visitor's IP address for sessions and location. If your site sits behind a proxy or CDN, configure ASP.NET Core's forwarded headers so the real address is passed on.
Using the numbers in your own code
Inject GoatCounterStats to build things like a "most read" list:
var views = await stats.ViewsByPathAsync(days: 7); // path -> views
More
Source, issues and a test site you can run: https://github.com/AndyCross/umbraco-goatcounter
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
-
net10.0
- Umbraco.Cms.Api.Common (>= 17.0.0)
- Umbraco.Cms.Api.Management (>= 17.0.0)
- Umbraco.Cms.Web.Common (>= 17.0.0)
- Umbraco.Cms.Web.Website (>= 17.0.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.