Skip to content

High performance, self-hosted, newsletter and mailing list manager with a modern dashboard. Single binary app.

Refactor campaign/list analytics to also optionally show unique count graphs. Closes #3085

Kailash Nadhb08fd5baac1a
diff --git a/cmd/campaign_analytics.go b/cmd/campaign_analytics.go
index de88660f..6e2f7550 100644
--- a/cmd/campaign_analytics.go
+++ b/cmd/campaign_analytics.go
@@ -16,6 +16,8 @@ type analyticsData struct {
Unsubscriptions []models.CampaignAnalyticsCount `json:"unsubscriptions"`
Views []models.CampaignAnalyticsCount `json:"views"`
Clicks []models.CampaignAnalyticsCount `json:"clicks"`
+ UniqueViews []models.CampaignAnalyticsCount `json:"unique_views,omitempty"`
+ UniqueClicks []models.CampaignAnalyticsCount `json:"unique_clicks,omitempty"`
Bounces []models.CampaignAnalyticsCount `json:"bounces"`
Links []models.CampaignAnalyticsLink `json:"links"`
}
@@ -32,6 +34,7 @@ type analyticsView struct {
Interval string
DisableTracking bool
IndividualTracking bool
+ ShowUnique bool
HasData bool
Counts struct {
@@ -39,6 +42,8 @@ type analyticsView struct {
Unsubscriptions int
Views int
Clicks int
+ UniqueViews int
+ UniqueClicks int
Bounces int
}
Data analyticsData
@@ -92,6 +97,7 @@ func (a *App) viewAnalytics(c echo.Context, resource string) error {
Interval: c.QueryParam("interval"),
DisableTracking: a.cfg.Privacy.DisableTracking,
IndividualTracking: a.cfg.Privacy.IndividualTracking,
+ ShowUnique: a.cfg.Privacy.IndividualTracking && c.QueryParam("unique") == "true",
}
data.CanViewCampaignCharts = resource == "campaigns" || (data.Can("campaigns:get", "campaigns:get_all") && data.Can("campaigns:get_analytics"))
@@ -136,16 +142,29 @@ func (a *App) viewAnalytics(c echo.Context, resource string) error {
}
if data.CanViewCampaignCharts {
var err error
- data.Data.Views, err = getCounts(ids, "views", fromStr, toStr, data.Interval)
+ data.Data.Views, err = getCounts(ids, "total_views", fromStr, toStr, data.Interval)
if err != nil {
return err
}
- data.Data.Clicks, err = getCounts(ids, "clicks", fromStr, toStr, data.Interval)
+ data.Data.Clicks, err = getCounts(ids, "total_clicks", fromStr, toStr, data.Interval)
if err != nil {
return err
}
+ if data.ShowUnique {
+ data.Data.UniqueViews, err = getCounts(ids, "views", fromStr, toStr, data.Interval)
+ if err != nil {
+ return err
+ }
+ data.Data.UniqueClicks, err = getCounts(ids, "clicks", fromStr, toStr, data.Interval)
+ if err != nil {
+ return err
+ }
+ data.Counts.UniqueViews = sumAnalyticsCounts(data.Data.UniqueViews)
+ data.Counts.UniqueClicks = sumAnalyticsCounts(data.Data.UniqueClicks)
+ }
+
data.Data.Bounces, err = getCounts(ids, "bounces", fromStr, toStr, data.Interval)
if err != nil {
return err
@@ -165,8 +184,17 @@ func (a *App) viewAnalytics(c echo.Context, resource string) error {
return c.Render(http.StatusOK, "admin-analytics", data)
}
-// GetCampaignViewAnalytics retrieves view counts for a campaign.
+// GetCampaignViewAnalytics retrieves analytics for campaigns.
func (a *App) GetCampaignViewAnalytics(c echo.Context) error {
+ return a.getAnalytics(c, "campaigns")
+}
+
+// GetListAnalytics retrieves analytics for lists.
+func (a *App) GetListAnalytics(c echo.Context) error {
+ return a.getAnalytics(c, "lists")
+}
+
+func (a *App) getAnalytics(c echo.Context, resource string) error {
ids, err := parseStringIDs(c.Request().URL.Query()["id"])
if err != nil {
return echo.NewHTTPError(http.StatusBadRequest,
@@ -178,11 +206,28 @@ func (a *App) GetCampaignViewAnalytics(c echo.Context) error {
a.i18n.Ts("globals.messages.missingFields", "name", "`id`"))
}
- // Ensure the user has access to campaigns via lists.
- for _, id := range ids {
- if err := a.checkCampaignPerm(auth.PermTypeGet, id, c); err != nil {
+ getCounts := a.core.GetCampaignAnalyticsCounts
+ getLinks := a.core.GetCampaignAnalyticsLinks
+ if resource == "lists" {
+ user := auth.GetUser(c)
+ if err := user.HasListPerm(auth.PermTypeGet, ids...); err != nil {
return err
}
+ // Match the list page: campaign metrics require campaign analytics access.
+ if typ := c.Param("type"); typ != "subscriptions" && typ != "unsubscriptions" {
+ if !(user.HasPerm(auth.PermCampaignsGet) || user.HasPerm(auth.PermCampaignsGetAll)) || !user.HasPerm(auth.PermCampaignsGetAnalytics) {
+ return auth.ErrPermDenied
+ }
+ }
+ getCounts = a.core.GetListAnalyticsCounts
+ getLinks = a.core.GetListAnalyticsLinks
+ } else {
+ // Ensure the user has access to campaigns via lists.
+ for _, id := range ids {
+ if err := a.checkCampaignPerm(auth.PermTypeGet, id, c); err != nil {
+ return err
+ }
+ }
}
var (
@@ -194,9 +239,9 @@ func (a *App) GetCampaignViewAnalytics(c echo.Context) error {
return echo.NewHTTPError(http.StatusBadRequest, a.i18n.T("analytics.invalidDates"))
}
- // Campaign link stats.
+ // Link stats.
if typ == "links" {
- out, err := a.core.GetCampaignAnalyticsLinks(ids, from, to)
+ out, err := getLinks(ids, from, to)
if err != nil {
return err
}
@@ -209,8 +254,16 @@ func (a *App) GetCampaignViewAnalytics(c echo.Context) error {
interval = "day"
}
- // Get the analytics numbers from the DB for the campaigns.
- out, err := a.core.GetCampaignAnalyticsCounts(ids, typ, from, to, interval)
+ // Views and clicks default to totals, with unique counts available when tracking is on.
+ if c.QueryParam("unique") != "true" || !a.cfg.Privacy.IndividualTracking {
+ switch typ {
+ case "views", "clicks":
+ typ = "total_" + typ
+ }
+ }
+
+ // Get the analytics numbers from the DB.
+ out, err := getCounts(ids, typ, from, to, interval)
if err != nil {
return err
}
diff --git a/cmd/handlers.go b/cmd/handlers.go
index 8be7d378..e5ba7154 100644
--- a/cmd/handlers.go
+++ b/cmd/handlers.go
@@ -206,6 +206,7 @@ func initHTTPHandlers(e *echo.Echo, a *App) {
// Individual list permissions are applied directly within handleGetLists.
g.GET("/api/lists", a.GetLists)
+ g.GET("/api/lists/analytics/:type", a.GetListAnalytics)
g.GET("/api/lists/:id", hasID(a.GetList))
g.POST("/api/lists", pm(a.CreateList, "lists:manage_all"))
g.PUT("/api/lists/:id", hasID(a.UpdateList))
diff --git a/cmd/init.go b/cmd/init.go
index 57ceb2f3..3f08a743 100644
--- a/cmd/init.go
+++ b/cmd/init.go
@@ -432,6 +432,15 @@ func prepareQueries(qMap goyesql.Queries, db *sqlx.DB, ko *koanf.Koanf) *models.
Query: fmt.Sprintf(qMap[countQuery].Query, "link_clicks"),
Tags: map[string]string{"name": "get-campaign-click-counts"},
}
+ for typ, table := range map[string]string{"view": "campaign_views", "click": "link_clicks"} {
+ for _, resource := range []string{"campaign", "list"} {
+ name := "get-" + resource + "-total-" + typ + "-counts"
+ qMap[name] = &goyesql.Query{
+ Query: fmt.Sprintf(qMap["get-"+resource+"-analytics-counts"].Query, table),
+ Tags: map[string]string{"name": name},
+ }
+ }
+ }
qMap["get-campaign-link-counts"].Query = fmt.Sprintf(qMap["get-campaign-link-counts"].Query, linkSel)
// List metrics use the same tracking semantics, grouped by campaign lists.
diff --git a/i18n/en.json b/i18n/en.json
index 5fb45f81..7bc2bb87 100644
--- a/i18n/en.json
+++ b/i18n/en.json
@@ -7,6 +7,7 @@
"analytics.links": "Links",
"analytics.nonIndividualTracking": "The counts are non-unique as individual subscriber tracking is turned off.",
"analytics.trackingDisabled": "E-mail tracking is globally disabled. No new views or clicks are being recorded.",
+ "analytics.showUnique": "Show unique counts?",
"analytics.title": "Analytics",
"analytics.toDate": "To",
"bounces.complaint": "Complaint",
@@ -292,6 +293,7 @@
"globals.terms.template": "Template | Templates",
"globals.terms.templates": "Templates",
"globals.terms.tx": "Transactional | Transactional",
+ "globals.terms.unique": "Unique",
"globals.terms.user": "User | Users",
"globals.terms.users": "Users",
"globals.terms.week": "Week | Weeks",
diff --git a/internal/core/campaigns.go b/internal/core/campaigns.go
index 2e8626c3..4c500a64 100644
--- a/internal/core/campaigns.go
+++ b/internal/core/campaigns.go
@@ -389,6 +389,10 @@ func (c *Core) GetCampaignAnalyticsCounts(campIDs []int, typ, fromDate, toDate,
stmt = c.q.GetCampaignViewCounts
case "clicks":
stmt = c.q.GetCampaignClickCounts
+ case "total_views":
+ stmt = c.q.GetCampaignTotalViewCounts
+ case "total_clicks":
+ stmt = c.q.GetCampaignTotalClickCounts
case "bounces":
stmt = c.q.GetCampaignBounceCounts
default:
diff --git a/internal/core/lists.go b/internal/core/lists.go
index d88676e2..48acb2da 100644
--- a/internal/core/lists.go
+++ b/internal/core/lists.go
@@ -251,6 +251,10 @@ func (c *Core) GetListAnalyticsCounts(ids []int, typ, fromDate, toDate, interval
stmt = c.q.GetListViewCounts
case "clicks":
stmt = c.q.GetListClickCounts
+ case "total_views":
+ stmt = c.q.GetListTotalViewCounts
+ case "total_clicks":
+ stmt = c.q.GetListTotalClickCounts
case "bounces":
stmt = c.q.GetListBounceCounts
default:
diff --git a/models/queries.go b/models/queries.go
index cfff52ea..9eaa8eed 100644
--- a/models/queries.go
+++ b/models/queries.go
@@ -58,6 +58,8 @@ type Queries struct {
GetListAnalyticsCounts string `query:"get-list-analytics-counts"`
GetListViewCounts *sqlx.Stmt `query:"get-list-view-counts"`
GetListClickCounts *sqlx.Stmt `query:"get-list-click-counts"`
+ GetListTotalViewCounts *sqlx.Stmt `query:"get-list-total-view-counts"`
+ GetListTotalClickCounts *sqlx.Stmt `query:"get-list-total-click-counts"`
GetListBounceCounts *sqlx.Stmt `query:"get-list-bounce-counts"`
GetListSubscriptionCounts *sqlx.Stmt `query:"get-list-subscription-counts"`
GetListUnsubscriptionCounts *sqlx.Stmt `query:"get-list-unsubscription-counts"`
@@ -84,15 +86,17 @@ type Queries struct {
// These two queries are read as strings and based on settings.individual_tracking=on/off,
// are interpolated and copied to view and click counts. Same query, different tables.
- GetCampaignAnalyticsCounts string `query:"get-campaign-analytics-counts"`
- GetCampaignViewCounts *sqlx.Stmt `query:"get-campaign-view-counts"`
- GetCampaignClickCounts *sqlx.Stmt `query:"get-campaign-click-counts"`
- GetCampaignLinkCounts *sqlx.Stmt `query:"get-campaign-link-counts"`
- GetCampaignBounceCounts *sqlx.Stmt `query:"get-campaign-bounce-counts"`
- DeleteCampaignViews *sqlx.Stmt `query:"delete-campaign-views"`
- DeleteCampaignLinkClicks *sqlx.Stmt `query:"delete-campaign-link-clicks"`
- ExportCampaignViews *sqlx.Stmt `query:"export-campaign-views"`
- ExportCampaignLinkClicks *sqlx.Stmt `query:"export-campaign-link-clicks"`
+ GetCampaignAnalyticsCounts string `query:"get-campaign-analytics-counts"`
+ GetCampaignViewCounts *sqlx.Stmt `query:"get-campaign-view-counts"`
+ GetCampaignClickCounts *sqlx.Stmt `query:"get-campaign-click-counts"`
+ GetCampaignLinkCounts *sqlx.Stmt `query:"get-campaign-link-counts"`
+ GetCampaignBounceCounts *sqlx.Stmt `query:"get-campaign-bounce-counts"`
+ DeleteCampaignViews *sqlx.Stmt `query:"delete-campaign-views"`
+ DeleteCampaignLinkClicks *sqlx.Stmt `query:"delete-campaign-link-clicks"`
+ ExportCampaignViews *sqlx.Stmt `query:"export-campaign-views"`
+ ExportCampaignLinkClicks *sqlx.Stmt `query:"export-campaign-link-clicks"`
+ GetCampaignTotalViewCounts *sqlx.Stmt `query:"get-campaign-total-view-counts"`
+ GetCampaignTotalClickCounts *sqlx.Stmt `query:"get-campaign-total-click-counts"`
NextCampaigns *sqlx.Stmt `query:"next-campaigns"`
GetRunningCampaign *sqlx.Stmt `query:"get-running-campaign"`
diff --git a/static/admin/assets/js/views/analytics.js b/static/admin/assets/js/views/analytics.js
index 6198cbf4..fcdb75fb 100644
--- a/static/admin/assets/js/views/analytics.js
+++ b/static/admin/assets/js/views/analytics.js
@@ -297,6 +297,15 @@ function renderCharts() {
renderCounts('subscriptions', camps, d.subscriptions || [], d.unsubscriptions || []);
renderCounts('views', camps, d.views || []);
renderCounts('clicks', camps, d.clicks || []);
+
+ if (d.unique_views) {
+ renderCounts('unique_views', camps, d.unique_views);
+ }
+
+ if (d.unique_clicks) {
+ renderCounts('unique_clicks', camps, d.unique_clicks);
+ }
+
renderCounts('bounces', camps, d.bounces || []);
renderLinks(d.links || []);
}
diff --git a/static/admin/views/analytics.html b/static/admin/views/analytics.html
index 03bba726..82ea30aa 100644
--- a/static/admin/views/analytics.html
+++ b/static/admin/views/analytics.html
@@ -41,8 +41,9 @@
</fieldset>
{{- if $d.DisableTracking }}
<span data-hint>{{ Icon "alert-triangle" }} {{ .L.T "analytics.trackingDisabled" }}</span>
- {{- else if not $d.IndividualTracking }}
- <span data-hint>{{ Icon "alert-triangle" }} {{ .L.T "analytics.nonIndividualTracking" }}</span>
+ {{- end }}
+ {{- if and $d.CanViewCampaignCharts $d.IndividualTracking }}
+ <label><input type="checkbox" name="unique" value="true" {{ if $d.ShowUnique }}checked{{ end }} /> {{ .L.T "analytics.showUnique" }}</label>
{{- end }}
</data>
</div>
@@ -77,7 +78,13 @@
{{- end }}
{{- if $d.CanViewCampaignCharts }}
{{ template "analytics-chart" dict "Title" (.L.T "campaigns.views") "Count" $d.Counts.Views "Key" "views" "Items" $d.Items "Resource" $d.Resource }}
+ {{- if $d.ShowUnique }}
+ {{ template "analytics-chart" dict "Title" (printf "%s (%s)" (.L.T "campaigns.views") (.L.T "globals.terms.unique")) "Count" $d.Counts.UniqueViews "Key" "unique_views" "Items" $d.Items "Resource" $d.Resource }}
+ {{- end }}
{{ template "analytics-chart" dict "Title" (.L.T "campaigns.clicks") "Count" $d.Counts.Clicks "Key" "clicks" "Items" $d.Items "Resource" $d.Resource }}
+ {{- if $d.ShowUnique }}
+ {{ template "analytics-chart" dict "Title" (printf "%s (%s)" (.L.T "campaigns.clicks") (.L.T "globals.terms.unique")) "Count" $d.Counts.UniqueClicks "Key" "unique_clicks" "Items" $d.Items "Resource" $d.Resource }}
+ {{- end }}
{{ template "analytics-chart" dict "Title" (.L.T "globals.terms.bounces") "Count" $d.Counts.Bounces "Key" "bounces" "Items" $d.Items "Resource" $d.Resource }}
<article class="card float">