Skip to content

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

Replicate Campaign analytics to new standalone List analytics.

Kailash Nadhdac8ee81d6cf
diff --git a/cmd/campaign_analytics.go b/cmd/campaign_analytics.go
index 8b6c0dc9..de88660f 100644
--- a/cmd/campaign_analytics.go
+++ b/cmd/campaign_analytics.go
@@ -9,59 +9,68 @@ import (
"github.com/labstack/echo/v4"
)
-// analyticsCampaign is used to render campaign items in the campaign analytics page selector.
-type analyticsCampaign struct {
- ID int `json:"id"`
- Name string `json:"name"`
- Sent int `json:"sent"`
-}
-
// analyticsData is the chart data embedded into the analytics page for the Chart.js renderer.
type analyticsData struct {
- Campaigns []analyticsCampaign `json:"campaigns"`
- Views []models.CampaignAnalyticsCount `json:"views"`
- Clicks []models.CampaignAnalyticsCount `json:"clicks"`
- Bounces []models.CampaignAnalyticsCount `json:"bounces"`
- Links []models.CampaignAnalyticsLink `json:"links"`
+ Items []models.AnalyticsItem `json:"items"`
+ Subscriptions []models.CampaignAnalyticsCount `json:"subscriptions"`
+ Unsubscriptions []models.CampaignAnalyticsCount `json:"unsubscriptions"`
+ Views []models.CampaignAnalyticsCount `json:"views"`
+ Clicks []models.CampaignAnalyticsCount `json:"clicks"`
+ Bounces []models.CampaignAnalyticsCount `json:"bounces"`
+ Links []models.CampaignAnalyticsLink `json:"links"`
}
-// campaignAnalyticsView is the admin view for the campaign analytics page.
-type campaignAnalyticsView struct {
+// analyticsView is the shared admin view for campaign and list analytics.
+type analyticsView struct {
adminView
- Campaigns []analyticsCampaign
- FromInput string
- ToInput string
- Interval string
- DisableTracking bool
- IndividualTracking bool
+ Items []models.AnalyticsItem
+ Resource string
+ CanViewCampaignCharts bool
+ FromInput string
+ ToInput string
+ Interval string
+ DisableTracking bool
+ IndividualTracking bool
HasData bool
Counts struct {
- Views int
- Clicks int
- Bounces int
+ Subscriptions int
+ Unsubscriptions int
+ Views int
+ Clicks int
+ Bounces int
}
Data analyticsData
}
// ViewCampaignAnalytics renders the HTML view for campaign analytics.
func (a *App) ViewCampaignAnalytics(c echo.Context) error {
- var campaigns []analyticsCampaign
- if ids, err := getQueryInts("id", c.QueryParams()); err == nil {
- for _, id := range ids {
- // Skip campaigns the user doesn't have access to.
- if err := a.checkCampaignPerm(auth.PermTypeGet, id, c); err != nil {
- continue
- }
+ return a.viewAnalytics(c, "campaigns")
+}
- camp, err := a.core.GetCampaign(id, "", "")
- if err != nil {
- continue
- }
+// ViewListAnalytics renders analytics for selected lists.
+func (a *App) ViewListAnalytics(c echo.Context) error {
+ return a.viewAnalytics(c, "lists")
+}
- campaigns = append(campaigns, analyticsCampaign{ID: camp.ID, Name: camp.Name, Sent: camp.Sent})
- }
+func (a *App) viewAnalytics(c echo.Context, resource string) error {
+ user := auth.GetUser(c)
+ ids, err := getQueryInts("id", c.QueryParams())
+ if err != nil {
+ return echo.NewHTTPError(http.StatusBadRequest,
+ a.i18n.Ts("globals.messages.errorInvalidIDs", "error", err.Error()))
+ }
+
+ getAll, permittedLists := user.GetPermittedLists(auth.PermTypeGet)
+ if resource == "campaigns" {
+ getAll, permittedLists = user.GetPermittedLists(auth.PermTypeGet | auth.PermTypeManage)
+ getAll = getAll || user.HasPerm(auth.PermCampaignsGetAll)
+ }
+
+ items, err := a.core.GetAnalyticsItems(resource, ids, getAll, permittedLists)
+ if err != nil {
+ return err
}
// Resolve the date range, defaulting to the last 7 days.
@@ -74,9 +83,10 @@ func (a *App) ViewCampaignAnalytics(c echo.Context) error {
to = t
}
- data := campaignAnalyticsView{
- adminView: newAdminView(c, a.i18n.T("analytics.title"), "", "campaigns.analytics"),
- Campaigns: campaigns,
+ data := analyticsView{
+ adminView: newAdminView(c, a.i18n.T("analytics.title"), "", resource+".analytics"),
+ Items: items,
+ Resource: resource,
FromInput: from.Format("2006-01-02T15:04"),
ToInput: to.Format("2006-01-02T15:04"),
Interval: c.QueryParam("interval"),
@@ -84,49 +94,75 @@ func (a *App) ViewCampaignAnalytics(c echo.Context) error {
IndividualTracking: a.cfg.Privacy.IndividualTracking,
}
+ data.CanViewCampaignCharts = resource == "campaigns" || (data.Can("campaigns:get", "campaigns:get_all") && data.Can("campaigns:get_analytics"))
+
if data.Interval == "" {
data.Interval = "day"
}
- // Pull analytics for the selected campaigns.
- if len(campaigns) > 0 {
+ // Pull analytics for the selected campaigns or lists.
+ if len(items) > 0 {
var (
fromStr = from.Format("2006-01-02 15:04:05")
toStr = to.Format("2006-01-02 15:04:05")
- ids = make([]int, len(campaigns))
+ ids = make([]int, len(items))
)
- for i, camp := range campaigns {
- ids[i] = camp.ID
+ for i, item := range items {
+ ids[i] = item.ID
}
- views, err := a.core.GetCampaignAnalyticsCounts(ids, "views", fromStr, toStr, data.Interval)
- if err != nil {
- return err
- }
+ data.HasData = true
+ data.Data.Items = items
+ getCounts := a.core.GetCampaignAnalyticsCounts
+ getLinks := a.core.GetCampaignAnalyticsLinks
+
+ if resource == "lists" {
+ getCounts = a.core.GetListAnalyticsCounts
+ getLinks = a.core.GetListAnalyticsLinks
+ rows, err := getCounts(ids, "subscriptions", fromStr, toStr, data.Interval)
+ if err != nil {
+ return err
+ }
- clicks, err := a.core.GetCampaignAnalyticsCounts(ids, "clicks", fromStr, toStr, data.Interval)
- if err != nil {
- return err
- }
+ data.Data.Subscriptions = rows
+ data.Counts.Subscriptions = sumAnalyticsCounts(rows)
+ rows, err = getCounts(ids, "unsubscriptions", fromStr, toStr, data.Interval)
+ if err != nil {
+ return err
+ }
- bounces, err := a.core.GetCampaignAnalyticsCounts(ids, "bounces", fromStr, toStr, data.Interval)
- if err != nil {
- return err
+ data.Data.Unsubscriptions = rows
+ data.Counts.Unsubscriptions = sumAnalyticsCounts(rows)
}
+ if data.CanViewCampaignCharts {
+ var err error
+ data.Data.Views, err = getCounts(ids, "views", fromStr, toStr, data.Interval)
+ if err != nil {
+ return err
+ }
- links, err := a.core.GetCampaignAnalyticsLinks(ids, "links", fromStr, toStr)
- if err != nil {
- return err
- }
+ data.Data.Clicks, err = getCounts(ids, "clicks", fromStr, toStr, data.Interval)
+ if err != nil {
+ return err
+ }
- data.HasData = true
- data.Data = analyticsData{Campaigns: campaigns, Views: views, Clicks: clicks, Bounces: bounces, Links: links}
- data.Counts.Views = sumAnalyticsCounts(views)
- data.Counts.Clicks = sumAnalyticsCounts(clicks)
- data.Counts.Bounces = sumAnalyticsCounts(bounces)
+ data.Data.Bounces, err = getCounts(ids, "bounces", fromStr, toStr, data.Interval)
+ if err != nil {
+ return err
+ }
+
+ data.Data.Links, err = getLinks(ids, fromStr, toStr)
+ if err != nil {
+ return err
+ }
+
+ data.Counts.Views = sumAnalyticsCounts(data.Data.Views)
+ data.Counts.Clicks = sumAnalyticsCounts(data.Data.Clicks)
+ data.Counts.Bounces = sumAnalyticsCounts(data.Data.Bounces)
+ }
}
- return c.Render(http.StatusOK, "admin-campaign-analytics", data)
+ return c.Render(http.StatusOK, "admin-analytics", data)
}
// GetCampaignViewAnalytics retrieves view counts for a campaign.
@@ -160,7 +196,7 @@ func (a *App) GetCampaignViewAnalytics(c echo.Context) error {
// Campaign link stats.
if typ == "links" {
- out, err := a.core.GetCampaignAnalyticsLinks(ids, typ, from, to)
+ out, err := a.core.GetCampaignAnalyticsLinks(ids, from, to)
if err != nil {
return err
}
diff --git a/cmd/handlers.go b/cmd/handlers.go
index 52b07ebd..8be7d378 100644
--- a/cmd/handlers.go
+++ b/cmd/handlers.go
@@ -83,6 +83,7 @@ func initHTTPHandlers(e *echo.Echo, a *App) {
g.GET(path.Join(uriAdmin, "/custom.js"), serveCustomAppearance("admin.custom_js"))
g.GET(uriAdmin, a.ViewDashboard)
g.GET(path.Join(uriAdmin, "/lists"), a.ViewLists)
+ g.GET(path.Join(uriAdmin, "/lists/analytics"), a.ViewListAnalytics)
g.GET(path.Join(uriAdmin, "/lists/new"), pm(a.ViewNewList, "lists:manage_all"))
g.GET(path.Join(uriAdmin, "/lists/:id"), hasID(a.ViewList))
g.GET(path.Join(uriAdmin, "/lists/:id/edit"), hasID(a.ViewList))
diff --git a/cmd/init.go b/cmd/init.go
index a4f1091f..57ceb2f3 100644
--- a/cmd/init.go
+++ b/cmd/init.go
@@ -434,6 +434,20 @@ func prepareQueries(qMap goyesql.Queries, db *sqlx.DB, ko *koanf.Koanf) *models.
}
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.
+ for typ, table := range map[string]string{"view": "campaign_views", "click": "link_clicks", "bounce": "bounces"} {
+ query := "get-list-analytics-counts"
+ if typ != "bounce" && ko.Bool("privacy.individual_tracking") {
+ query = "get-list-analytics-unique-counts"
+ }
+ name := "get-list-" + typ + "-counts"
+ qMap[name] = &goyesql.Query{
+ Query: fmt.Sprintf(qMap[query].Query, table),
+ Tags: map[string]string{"name": name},
+ }
+ }
+ qMap["get-list-link-counts"].Query = fmt.Sprintf(qMap["get-list-link-counts"].Query, linkSel)
+
// Scan and prepare all queries.
var q models.Queries
if err := goyesqlx.ScanToStruct(&q, qMap, db); err != nil {
diff --git a/internal/core/campaigns.go b/internal/core/campaigns.go
index b3494ad0..2e8626c3 100644
--- a/internal/core/campaigns.go
+++ b/internal/core/campaigns.go
@@ -395,35 +395,12 @@ func (c *Core) GetCampaignAnalyticsCounts(campIDs []int, typ, fromDate, toDate,
return nil, echo.NewHTTPError(http.StatusBadRequest, c.i18n.T("globals.messages.invalidData"))
}
- if !strHasLen(fromDate, 10, 30) || !strHasLen(toDate, 10, 30) {
- return nil, echo.NewHTTPError(http.StatusBadRequest, c.i18n.T("analytics.invalidDates"))
- }
- switch interval {
- case "hour", "day", "week", "month":
- default:
- return nil, echo.NewHTTPError(http.StatusBadRequest, c.i18n.T("globals.messages.invalidData"))
- }
-
- out := []models.CampaignAnalyticsCount{}
- if err := stmt.Select(&out, pq.Array(campIDs), fromDate, toDate, interval); err != nil {
- c.log.Printf("error fetching campaign %s: %v", typ, err)
- return nil, echo.NewHTTPError(http.StatusInternalServerError,
- c.i18n.Ts("globals.messages.errorFetching", "name", "{globals.terms.analytics}", "error", pqErrMsg(err)))
- }
-
- return out, nil
+ return c.getAnalyticsCounts(stmt, campIDs, fromDate, toDate, interval)
}
// GetCampaignAnalyticsLinks returns link click analytics for the given campaign IDs.
-func (c *Core) GetCampaignAnalyticsLinks(campIDs []int, typ, fromDate, toDate string) ([]models.CampaignAnalyticsLink, error) {
- out := []models.CampaignAnalyticsLink{}
- if err := c.q.GetCampaignLinkCounts.Select(&out, pq.Array(campIDs), fromDate, toDate); err != nil {
- c.log.Printf("error fetching campaign %s: %v", typ, err)
- return nil, echo.NewHTTPError(http.StatusInternalServerError,
- c.i18n.Ts("globals.messages.errorFetching", "name", "{globals.terms.analytics}", "error", pqErrMsg(err)))
- }
-
- return out, nil
+func (c *Core) GetCampaignAnalyticsLinks(ids []int, fromDate, toDate string) ([]models.CampaignAnalyticsLink, error) {
+ return c.getAnalyticsLinks(c.q.GetCampaignLinkCounts, ids, fromDate, toDate)
}
// RegisterCampaignView registers a subscriber's view on a campaign.
diff --git a/internal/core/lists.go b/internal/core/lists.go
index 213cfaa5..d88676e2 100644
--- a/internal/core/lists.go
+++ b/internal/core/lists.go
@@ -4,6 +4,7 @@ import (
"net/http"
"github.com/gofrs/uuid/v5"
+ "github.com/jmoiron/sqlx"
"github.com/jmoiron/sqlx/types"
"github.com/knadh/listmonk/models"
"github.com/labstack/echo/v4"
@@ -237,3 +238,28 @@ func (c *Core) GetListCharts(id int, campaignViews bool) (types.JSONText, error)
}
return out, nil
}
+
+// GetListAnalyticsCounts returns subscriptions or campaign events grouped by list.
+func (c *Core) GetListAnalyticsCounts(ids []int, typ, fromDate, toDate, interval string) ([]models.CampaignAnalyticsCount, error) {
+ var stmt *sqlx.Stmt
+ switch typ {
+ case "subscriptions":
+ stmt = c.q.GetListSubscriptionCounts
+ case "unsubscriptions":
+ stmt = c.q.GetListUnsubscriptionCounts
+ case "views":
+ stmt = c.q.GetListViewCounts
+ case "clicks":
+ stmt = c.q.GetListClickCounts
+ case "bounces":
+ stmt = c.q.GetListBounceCounts
+ default:
+ return nil, echo.NewHTTPError(http.StatusBadRequest, c.i18n.T("globals.messages.invalidData"))
+ }
+ return c.getAnalyticsCounts(stmt, ids, fromDate, toDate, interval)
+}
+
+// GetListAnalyticsLinks returns link counts across campaigns by lists.
+func (c *Core) GetListAnalyticsLinks(ids []int, fromDate, toDate string) ([]models.CampaignAnalyticsLink, error) {
+ return c.getAnalyticsLinks(c.q.GetListLinkCounts, ids, fromDate, toDate)
+}
diff --git a/internal/migrations/v7.0.0.go b/internal/migrations/v7.0.0.go
index defb54df..e6608a75 100644
--- a/internal/migrations/v7.0.0.go
+++ b/internal/migrations/v7.0.0.go
@@ -16,27 +16,34 @@ func V7_0_0(db *sqlx.DB, fs stuffbin.FileSystem, ko *koanf.Koanf, lo *log.Logger
// List analytics.
if _, err := db.Exec(`
-CREATE MATERIALIZED VIEW IF NOT EXISTS mat_list_charts AS
- -- Aggregate campaign events before joining lists so multi-list campaigns do not
- -- multiply the work over the raw events. Views belong to campaigns, not lists.
+DROP MATERIALIZED VIEW IF EXISTS mat_list_charts;
+CREATE MATERIALIZED VIEW mat_list_charts AS
WITH views AS (
SELECT campaign_id, DATE_TRUNC('week', created_at)::DATE AS date, COUNT(*) AS count
FROM campaign_views
- WHERE created_at >= CURRENT_DATE - INTERVAL '12 months' AND created_at <= NOW()
+ WHERE created_at >= CURRENT_DATE - INTERVAL '3 months' AND created_at <= NOW()
GROUP BY campaign_id, date
), counts AS (
SELECT list_id, DATE_TRUNC('week', created_at)::DATE AS date,
- COUNT(*) AS subscriptions, 0::BIGINT AS campaign_views
+ COUNT(*) AS subscriptions, 0::BIGINT AS unsubscriptions, 0::BIGINT AS campaign_views
FROM subscriber_lists
- WHERE created_at >= CURRENT_DATE - INTERVAL '12 months' AND created_at <= NOW()
+ WHERE created_at >= CURRENT_DATE - INTERVAL '3 months' AND created_at <= NOW()
GROUP BY list_id, date
UNION ALL
- SELECT cl.list_id, v.date, 0::BIGINT, SUM(v.count)::BIGINT
+ SELECT list_id, DATE_TRUNC('week', updated_at)::DATE AS date,
+ 0::BIGINT, COUNT(*), 0::BIGINT
+ FROM subscriber_lists
+ WHERE status = 'unsubscribed'
+ AND updated_at >= CURRENT_DATE - INTERVAL '3 months' AND updated_at <= NOW()
+ GROUP BY list_id, date
+ UNION ALL
+ SELECT cl.list_id, v.date, 0::BIGINT, 0::BIGINT, SUM(v.count)::BIGINT
FROM views v JOIN campaign_lists cl ON cl.campaign_id = v.campaign_id
WHERE cl.list_id IS NOT NULL
GROUP BY cl.list_id, v.date
)
SELECT list_id, date, SUM(subscriptions)::BIGINT AS subscriptions,
+ SUM(unsubscriptions)::BIGINT AS unsubscriptions,
SUM(campaign_views)::BIGINT AS campaign_views
FROM counts
GROUP BY list_id, date;
diff --git a/models/queries.go b/models/queries.go
index 7a4d3500..cfff52ea 100644
--- a/models/queries.go
+++ b/models/queries.go
@@ -53,7 +53,16 @@ type Queries struct {
DeleteSubscriptionsByQuery string `query:"delete-subscriptions-by-query"`
UnsubscribeSubscribersFromListsByQuery string `query:"unsubscribe-subscribers-from-lists-by-query"`
- GetListCharts *sqlx.Stmt `query:"get-list-charts"`
+ GetListAnalyticsItems *sqlx.Stmt `query:"get-list-analytics-items"`
+ GetCampaignAnalyticsItems *sqlx.Stmt `query:"get-campaign-analytics-items"`
+ GetListAnalyticsCounts string `query:"get-list-analytics-counts"`
+ GetListViewCounts *sqlx.Stmt `query:"get-list-view-counts"`
+ GetListClickCounts *sqlx.Stmt `query:"get-list-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"`
+ GetListLinkCounts *sqlx.Stmt `query:"get-list-link-counts"`
+ GetListCharts *sqlx.Stmt `query:"get-list-charts"`
CreateList *sqlx.Stmt `query:"create-list"`
QueryLists string `query:"query-lists"`
diff --git a/models/templates.go b/models/templates.go
index 0e7fa7f7..0a820df5 100644
--- a/models/templates.go
+++ b/models/templates.go
@@ -69,7 +69,15 @@ type CampaignStats struct {
NetRate int `json:"net_rate"`
}
+// AnalyticsItem is the minimal campaign or list metadata used by analytics.
+type AnalyticsItem struct {
+ ID int `db:"id" json:"id"`
+ Name string `db:"name" json:"name"`
+ Sent int `db:"sent" json:"sent"`
+}
+
type CampaignAnalyticsCount struct {
+ ListID int `db:"list_id" json:"list_id,omitempty"`
CampaignID int `db:"campaign_id" json:"campaign_id"`
Count int `db:"count" json:"count"`
Timestamp time.Time `db:"timestamp" json:"timestamp"`
diff --git a/queries/campaigns.sql b/queries/campaigns.sql
index 0bee3e2d..265059c5 100644
--- a/queries/campaigns.sql
+++ b/queries/campaigns.sql
@@ -478,3 +478,10 @@ WITH view AS (
)
INSERT INTO campaign_views (campaign_id, subscriber_id)
VALUES((SELECT campaign_id FROM view), (SELECT subscriber_id FROM view));
+
+-- name: get-campaign-analytics-items
+SELECT id, name, sent FROM campaigns c
+WHERE id = ANY($1::INT[]) AND ($2 OR EXISTS (
+ SELECT 1 FROM campaign_lists WHERE campaign_id = c.id AND list_id = ANY($3::INT[])
+))
+ORDER BY ARRAY_POSITION($1::INT[], id);
diff --git a/queries/lists.sql b/queries/lists.sql
index af4261ae..32dd9e61 100644
--- a/queries/lists.sql
+++ b/queries/lists.sql
@@ -104,13 +104,72 @@ END;
-- name: get-list-charts
-- Fill missing weeks, including empty/new lists absent from the cached view.
WITH weeks AS (
- SELECT GENERATE_SERIES(DATE_TRUNC('week', CURRENT_DATE - INTERVAL '12 months'),
+ SELECT GENERATE_SERIES(DATE_TRUNC('week', CURRENT_DATE - INTERVAL '3 months'),
DATE_TRUNC('week', CURRENT_DATE), INTERVAL '1 week')::DATE AS date
)
SELECT JSON_BUILD_OBJECT(
+ 'unsubscriptions', JSON_AGG(JSON_BUILD_OBJECT('date', w.date, 'count', COALESCE(c.unsubscriptions, 0)) ORDER BY w.date),
'subscriptions', JSON_AGG(JSON_BUILD_OBJECT('date', w.date, 'count', COALESCE(c.subscriptions, 0)) ORDER BY w.date),
'campaign_views', CASE WHEN $2::BOOLEAN THEN
JSON_AGG(JSON_BUILD_OBJECT('date', w.date, 'count', COALESCE(c.campaign_views, 0)) ORDER BY w.date)
ELSE '[]'::JSON END
)
FROM weeks w LEFT JOIN mat_list_charts c ON c.list_id = $1 AND c.date = w.date;
+
+-- name: get-list-analytics-counts
+-- raw: true
+WITH counts AS (
+ SELECT campaign_id, COUNT(*) AS "count", DATE_TRUNC($4::TEXT, created_at) AS "timestamp"
+ FROM %s
+ WHERE campaign_id IN (SELECT campaign_id FROM campaign_lists WHERE list_id = ANY($1))
+ AND created_at >= $2 AND created_at <= $3
+ GROUP BY campaign_id, "timestamp"
+)
+SELECT cl.list_id, SUM(c.count)::BIGINT AS "count", c.timestamp
+FROM counts c JOIN campaign_lists cl ON cl.campaign_id = c.campaign_id
+WHERE cl.list_id = ANY($1)
+GROUP BY cl.list_id, c.timestamp ORDER BY c.timestamp;
+
+-- name: get-list-subscription-counts
+SELECT list_id, COUNT(*) AS "count", DATE_TRUNC($4::TEXT, created_at) AS "timestamp"
+FROM subscriber_lists
+WHERE list_id = ANY($1) AND created_at >= $2 AND created_at <= $3
+GROUP BY list_id, "timestamp" ORDER BY "timestamp" ASC;
+
+-- name: get-list-unsubscription-counts
+-- Memberships retain only their current status and last update, not event history.
+SELECT list_id, COUNT(*) AS "count", DATE_TRUNC($4::TEXT, updated_at) AS "timestamp"
+FROM subscriber_lists
+WHERE list_id = ANY($1) AND status = 'unsubscribed' AND updated_at >= $2 AND updated_at <= $3
+GROUP BY list_id, "timestamp" ORDER BY "timestamp" ASC;
+
+-- name: get-list-link-counts
+-- raw: true
+SELECT COUNT(%s) AS "count", url
+FROM link_clicks LEFT JOIN links ON link_clicks.link_id = links.id
+WHERE campaign_id IN (SELECT campaign_id FROM campaign_lists WHERE list_id = ANY($1))
+ AND link_clicks.created_at >= $2 AND link_clicks.created_at <= $3
+GROUP BY links.url ORDER BY "count" DESC LIMIT 50;
+
+-- name: get-list-analytics-unique-counts
+-- raw: true
+WITH uniq AS (
+ SELECT DISTINCT ON (subscriber_id, campaign_id)
+ campaign_id, DATE_TRUNC($4::TEXT, created_at) AS "timestamp"
+ FROM %s
+ WHERE campaign_id IN (SELECT campaign_id FROM campaign_lists WHERE list_id = ANY($1))
+ AND created_at >= $2 AND created_at <= $3
+ ORDER BY subscriber_id, campaign_id, "timestamp"
+), counts AS (
+ SELECT campaign_id, COUNT(*) AS "count", "timestamp"
+ FROM uniq GROUP BY campaign_id, "timestamp"
+)
+SELECT cl.list_id, SUM(c.count)::BIGINT AS "count", c.timestamp
+FROM counts c JOIN campaign_lists cl ON cl.campaign_id = c.campaign_id
+WHERE cl.list_id = ANY($1)
+GROUP BY cl.list_id, c.timestamp ORDER BY c.timestamp;
+
+-- name: get-list-analytics-items
+SELECT id, name FROM lists
+WHERE id = ANY($1::INT[]) AND ($2 OR id = ANY($3::INT[]))
+ORDER BY ARRAY_POSITION($1::INT[], id);
diff --git a/schema.sql b/schema.sql
index 67a834af..ec59b405 100644
--- a/schema.sql
+++ b/schema.sql
@@ -444,27 +444,35 @@ CREATE MATERIALIZED VIEW mat_list_subscriber_stats AS
SELECT NOW() AS updated_at, 0 AS list_id, NULL AS status, COUNT(id) AS subscriber_count FROM subscribers;
DROP INDEX IF EXISTS mat_list_subscriber_stats_idx; CREATE UNIQUE INDEX mat_list_subscriber_stats_idx ON mat_list_subscriber_stats (list_id, status);
--- Weekly list charts for the latest twelve months.
+-- Weekly list charts for the latest three months.
DROP MATERIALIZED VIEW IF EXISTS mat_list_charts;
CREATE MATERIALIZED VIEW mat_list_charts AS
WITH views AS (
SELECT campaign_id, DATE_TRUNC('week', created_at)::DATE AS date, COUNT(*) AS count
FROM campaign_views
- WHERE created_at >= CURRENT_DATE - INTERVAL '12 months' AND created_at <= NOW()
+ WHERE created_at >= CURRENT_DATE - INTERVAL '3 months' AND created_at <= NOW()
GROUP BY campaign_id, date
), counts AS (
SELECT list_id, DATE_TRUNC('week', created_at)::DATE AS date,
- COUNT(*) AS subscriptions, 0::BIGINT AS campaign_views
+ COUNT(*) AS subscriptions, 0::BIGINT AS unsubscriptions, 0::BIGINT AS campaign_views
FROM subscriber_lists
- WHERE created_at >= CURRENT_DATE - INTERVAL '12 months' AND created_at <= NOW()
+ WHERE created_at >= CURRENT_DATE - INTERVAL '3 months' AND created_at <= NOW()
GROUP BY list_id, date
UNION ALL
- SELECT cl.list_id, v.date, 0::BIGINT, SUM(v.count)::BIGINT
+ SELECT list_id, DATE_TRUNC('week', updated_at)::DATE AS date,
+ 0::BIGINT, COUNT(*), 0::BIGINT
+ FROM subscriber_lists
+ WHERE status = 'unsubscribed'
+ AND updated_at >= CURRENT_DATE - INTERVAL '3 months' AND updated_at <= NOW()
+ GROUP BY list_id, date
+ UNION ALL
+ SELECT cl.list_id, v.date, 0::BIGINT, 0::BIGINT, SUM(v.count)::BIGINT
FROM views v JOIN campaign_lists cl ON cl.campaign_id = v.campaign_id
WHERE cl.list_id IS NOT NULL
GROUP BY cl.list_id, v.date
)
SELECT list_id, date, SUM(subscriptions)::BIGINT AS subscriptions,
+ SUM(unsubscriptions)::BIGINT AS unsubscriptions,
SUM(campaign_views)::BIGINT AS campaign_views
FROM counts
GROUP BY list_id, date;
diff --git a/static/admin/assets/js/charts.js b/static/admin/assets/js/charts.js
index 2d974254..89cf42d5 100644
--- a/static/admin/assets/js/charts.js
+++ b/static/admin/assets/js/charts.js
@@ -14,8 +14,8 @@ function label(iso) {
return d.toLocaleDateString(undefined, { day: '2-digit', month: 'short' });
}
-// Draw a filled line chart of {count, date} rows on the given canvas.
-export function lineChart(id, rows) {
+// Draw {count, date} rows, optionally adding a dashed comparison series.
+export function lineChart(id, rows, comparison) {
const canvas = document.getElementById(id);
if (!canvas) {
return;
@@ -31,26 +31,36 @@ export function lineChart(id, rows) {
const data = rows || [];
Chart.defaults.font.family = FONT_FAMILY;
+ const datasets = [{
+ label: canvas.getAttribute('aria-label'),
+ data: data.map((d) => d.count),
+ borderColor: color,
+ backgroundColor: `${color.replace('rgb(', 'rgba(').replace(')', ', 0.0314)')}`,
+ borderWidth: 2,
+ fill: true,
+ tension: 0.35,
+ pointBorderWidth: 0.5,
+ pointHoverBorderWidth: 5,
+ }];
+ if (comparison) {
+ const counts = new Map(comparison.map((d) => [d.date, d.count]));
+ datasets.push({
+ ...datasets[0],
+ label: canvas.dataset.extraLabel,
+ data: data.map((d) => counts.get(d.date) || 0),
+ borderDash: [6, 4],
+ fill: false,
+ });
+ }
+
// eslint-disable-next-line no-new
new Chart(canvas, {
type: 'line',
- data: {
- labels: data.map((d) => label(d.date)),
- datasets: [{
- data: data.map((d) => d.count),
- borderColor: color,
- backgroundColor: `${color.replace('rgb(', 'rgba(').replace(')', ', 0.0314)')}`,
- borderWidth: 2,
- fill: true,
- tension: 0.35,
- pointBorderWidth: 0.5,
- pointHoverBorderWidth: 5,
- }],
- },
+ data: { labels: data.map((d) => label(d.date)), datasets },
options: {
responsive: true,
maintainAspectRatio: false,
- plugins: { legend: { display: false } },
+ plugins: { legend: { display: !!comparison } },
scales: {
x: { grid: { display: false }, border: { display: false } },
y: { grid: { display: false }, border: { display: false }, ticks: { precision: 0 } },
diff --git a/static/admin/assets/js/views/analytics.js b/static/admin/assets/js/views/analytics.js
index c76482e8..6198cbf4 100644
--- a/static/admin/assets/js/views/analytics.js
+++ b/static/admin/assets/js/views/analytics.js
@@ -112,8 +112,8 @@ function toLabel(s) {
return `${d.getFullYear()}-${pad(d.getMonth() + 1)}-${pad(d.getDate())} ${pad(d.getHours())}:${pad(d.getMinutes())}`;
}
-// CampaignTag is the object used in the <ot-taginput> campaign selector.
-class CampaignTag {
+// AnalyticsTag is the object used in the <ot-taginput> analytics selector.
+class AnalyticsTag {
constructor(c) {
this.id = c.id;
this.name = c.name;
@@ -124,17 +124,17 @@ class CampaignTag {
}
}
-// analyticsForm is the Alpine component for the campaign analytics page.
+// analyticsForm is the Alpine component for the analytics page.
function analyticsForm() {
let queryTimer = null;
return {
- campaigns: (window._selectedCampaigns || []).map((c) => new CampaignTag(c)),
+ items: (window._selectedItems || []).map((c) => new AnalyticsTag(c)),
// Set on submit to give feedback during the full-page reload.
submitting: false,
- // Populate the selector's suggestions with the campaigns API.
+ // Populate the selector's suggestions with the resource API.
onQuery(el) {
clearTimeout(queryTimer);
queryTimer = setTimeout(async () => {
@@ -149,12 +149,12 @@ function analyticsForm() {
});
try {
- const data = await api('analytics.campaigns', `/campaigns?${params.toString()}`, 'GET');
+ const data = await api(`analytics.${window._analyticsResource}`, `/${window._analyticsResource}?${params.toString()}`, 'GET');
el.list.replaceChildren(...(data.results || [])
.filter((c) => !chosen.has(c.id))
.map((c) => {
const o = new Option(`#${c.id}: ${c.name}`);
- o.data = new CampaignTag(c);
+ o.data = new AnalyticsTag(c);
return o;
}));
} catch (err) { /* api() shows a toast. */ }
@@ -182,12 +182,29 @@ function formatCount(count, sent) {
return sent > 0 ? `${count} (${((count / sent) * 100).toFixed(2)}%)` : `${count}`;
}
-// Render a line chart (time series per campaign) and its donut (totals per campaign).
-function renderCounts(key, camps, rows) {
- const datasets = camps.map((c, n) => ({
+// Group each series once for chart points and legend totals.
+function groupCounts(rows, idKey) {
+ const groups = new Map();
+ rows.forEach((row) => {
+ const id = row[idKey];
+ if (!groups.has(id)) {
+ groups.set(id, { points: [], total: 0 });
+ }
+ const group = groups.get(id);
+ group.points.push({ x: toLabel(row.timestamp), y: row.count });
+ group.total += row.count;
+ });
+ return groups;
+}
+
+// Render per-item time series and totals, with optional unsubscription lines.
+function renderCounts(key, items, rows, unsubscriptions) {
+ const idKey = window._analyticsResource === 'lists' ? 'list_id' : 'campaign_id';
+ const counts = groupCounts(rows, idKey);
+ const unsubs = groupCounts(unsubscriptions || [], idKey);
+ const datasets = items.map((c, n) => ({
label: `#${c.id}: ${c.name}`,
- data: rows.filter((item) => item.campaign_id === c.id)
- .map((item) => ({ x: toLabel(item.timestamp), y: item.count })),
+ data: counts.get(c.id)?.points || [],
borderColor: chartColors[n % chartColors.length],
backgroundColor: chartColors[n % chartColors.length],
borderWidth: 2,
@@ -195,18 +212,25 @@ function renderCounts(key, camps, rows) {
pointBorderWidth: 0.5,
}));
- const labels = [];
- const totals = camps.map((c) => {
- labels.push(`#${c.id}: ${c.name}`);
- return rows.reduce((a, item) => (item.campaign_id === c.id ? a + item.count : a), 0);
- });
+ const labels = datasets.map((d) => d.label);
+ const totals = items.map((c) => counts.get(c.id)?.total || 0);
+
+ if (unsubscriptions) {
+ const label = document.getElementById(`chart-${key}`)?.dataset.extraLabel;
+ datasets.push(...items.map((c, n) => ({
+ ...datasets[n],
+ label: `${datasets[n].label}: ${label}`,
+ data: unsubs.get(c.id)?.points || [],
+ borderDash: [6, 4],
+ })));
+ }
draw(`chart-${key}`, DEFAULT_LINE, { datasets });
const donut = draw(`chart-${key}-donut`, DEFAULT_DONUT, {
labels,
datasets: [{
data: totals,
- sent: camps.map((c) => c.sent),
+ sent: items.map((c) => c.sent),
backgroundColor: chartColors,
borderWidth: 6,
}],
@@ -217,7 +241,11 @@ function renderCounts(key, camps, rows) {
legend.querySelectorAll('[data-index]').forEach((item) => {
const n = Number(item.dataset.index);
item.querySelector('[data-marker]').style.color = datasets[n].borderColor;
- item.querySelector('[data-count]').textContent = formatCount(totals[n], camps[n].sent);
+ item.querySelector('[data-count]').textContent = formatCount(totals[n], items[n].sent);
+ const unsubCount = item.querySelector('[data-unsubscription-count]');
+ if (unsubCount) {
+ unsubCount.textContent = unsubs.get(items[n].id)?.total || 0;
+ }
const highlight = () => {
donut.setActiveElements(item.matches(':hover, :focus-within') ? [{ datasetIndex: 0, index: n }] : []);
@@ -265,7 +293,8 @@ function renderCharts() {
return;
}
- const camps = d.campaigns || [];
+ const camps = d.items || [];
+ renderCounts('subscriptions', camps, d.subscriptions || [], d.unsubscriptions || []);
renderCounts('views', camps, d.views || []);
renderCounts('clicks', camps, d.clicks || []);
renderCounts('bounces', camps, d.bounces || []);
diff --git a/static/admin/assets/js/views/lists.js b/static/admin/assets/js/views/lists.js
index c4a69008..5c334ad1 100644
--- a/static/admin/assets/js/views/lists.js
+++ b/static/admin/assets/js/views/lists.js
@@ -114,5 +114,5 @@ document.addEventListener('alpine:init', () => {
}, { once: true });
const charts = window._listCharts || {};
-lineChart('chart-subscriptions', charts.subscriptions);
+lineChart('chart-subscriptions', charts.subscriptions, charts.unsubscriptions);
lineChart('chart-list-views', charts.campaign_views);
diff --git a/static/admin/partials/list-info.html b/static/admin/partials/list-info.html
index 0b4aa37c..68b8e356 100644
--- a/static/admin/partials/list-info.html
+++ b/static/admin/partials/list-info.html
@@ -54,7 +54,7 @@
<div class="col-6">
<article class="card float">
<h5 class="title">{{ .L.Tc "globals.terms.subscriptions" 2 }}</h5>
- <div class="chart-box"><canvas id="chart-subscriptions" role="img" aria-label="{{ .L.Tc "globals.terms.subscriptions" 2 }}"></canvas></div>
+ <div class="chart-box"><canvas id="chart-subscriptions" data-extra-label="{{ .L.T "subscribers.status.unsubscribed" }}" role="img" aria-label="{{ .L.Tc "globals.terms.subscriptions" 2 }}"></canvas></div>
</article>
</div>
{{ if $d.CanViewCampaignCharts }}
diff --git a/static/admin/partials/sidebar.html b/static/admin/partials/sidebar.html
index 085119ae..15aebc65 100644
--- a/static/admin/partials/sidebar.html
+++ b/static/admin/partials/sidebar.html
@@ -13,6 +13,7 @@
<ul>
<li><a href="{{ URI "/admin/lists" }}" {{ IsNav $p "lists.all" }} data-cy="all-lists">{{ .L.T "menu.allLists" }}</a></li>
<li><a href="{{ URI "/admin/lists" }}?status=archived" {{ IsNav $p "lists.archived" }} data-cy="archived-lists">{{ .L.T "lists.archived" }}</a></li>
+ <li><a href="{{ URI "/admin/lists/analytics" }}" {{ IsNav $p "lists.analytics" }} data-cy="list-analytics">{{ .L.T "globals.terms.analytics" }}</a></li>
<li><a href="{{ URI "/admin/lists/forms" }}" {{ IsNav $p "lists.forms" }} data-cy="forms">{{ .L.T "menu.forms" }}</a></li>
</ul>
</details>
diff --git a/static/admin/views/analytics.html b/static/admin/views/analytics.html
index 358e8829..03bba726 100644
--- a/static/admin/views/analytics.html
+++ b/static/admin/views/analytics.html
@@ -1,10 +1,11 @@
-{{ define "admin-campaign-analytics" -}}
+{{ define "admin-analytics" -}}
{{ template "admin-header" . }}
-{{ template "breadcrumbs" dict "Root" . "Current" .Data.Title "Parents" (list (dict "Label" (.L.T "globals.terms.campaigns") "URL" (URI "/admin/campaigns") "CanLink" (.Data.Can "campaigns:get" "campaigns:get_all"))) }}
{{- $d := .Data -}}
+{{ template "breadcrumbs" dict "Root" . "Current" .Data.Title "Parents" (list (dict "Label" (.L.T (printf "globals.terms.%s" $d.Resource)) "URL" (URI (printf "/admin/%s" $d.Resource)) "CanLink" (or (eq $d.Resource "lists") ($d.Can "campaigns:get" "campaigns:get_all")))) }}
<script>
- window._selectedCampaigns = {{ ToJSON $d.Campaigns }};
+ window._analyticsResource = {{ $d.Resource }};
+ window._selectedItems = {{ ToJSON $d.Items }};
window._analytics = {{ if $d.HasData }}{{ ToJSON $d.Data }}{{ else }}null{{ end }};
</script>
@@ -14,19 +15,19 @@
</header>
<div class="vstack gap-6">
- <form method="get" action="{{ URI "/admin/campaigns/analytics" }}" x-data="analyticsForm()" @submit="submitting = true">
+ <form method="get" action="{{ URI (printf "/admin/%s/analytics" $d.Resource) }}" x-data="analyticsForm()" @submit="submitting = true">
<div class="card float">
<h4 class="title">{{ .L.T "analytics.title" }}</h4>
<div class="row">
<div class="col-4">
<label data-field>
- {{ .L.T "globals.terms.campaigns" }}
- <ot-taginput x-model="campaigns">
- <input list="analytics-campaigns" placeholder="{{ .L.T "globals.terms.campaigns" }}" @input="onQuery($el)" @pointerdown="onQuery($el)" @focus="onQuery($el)" />
- <datalist id="analytics-campaigns"></datalist>
+ {{ .L.T (printf "globals.terms.%s" $d.Resource) }}
+ <ot-taginput x-model="items">
+ <input list="analytics-items" placeholder="{{ .L.T (printf "globals.terms.%s" $d.Resource) }}" @input="onQuery($el)" @pointerdown="onQuery($el)" @focus="onQuery($el)" />
+ <datalist id="analytics-items"></datalist>
</ot-taginput>
</label>
- <template x-for="c in campaigns" :key="c.id">
+ <template x-for="c in items" :key="c.id">
<input type="hidden" name="id" :value="c.id" />
</template>
</div>
@@ -61,7 +62,7 @@
<div class="col-1">
<data data-field>
<label aria-hidden="true">&nbsp;</label>
- <button type="submit" data-cy="btn-search" aria-label="{{ .L.T "globals.buttons.search" }}" :disabled="campaigns.length === 0 || submitting" :aria-busy="submitting" data-spinner="small">
+ <button type="submit" data-cy="btn-search" aria-label="{{ .L.T "globals.buttons.search" }}" :disabled="items.length === 0 || submitting" :aria-busy="submitting" data-spinner="small">
{{ .L.T "globals.buttons.view" }}
</button>
</data>
@@ -71,18 +72,23 @@
</form>
{{- if $d.HasData }}
- {{ template "analytics-chart" dict "Title" (.L.T "campaigns.views") "Count" $d.Counts.Views "Key" "views" "Campaigns" $d.Campaigns }}
- {{ template "analytics-chart" dict "Title" (.L.T "campaigns.clicks") "Count" $d.Counts.Clicks "Key" "clicks" "Campaigns" $d.Campaigns }}
- {{ template "analytics-chart" dict "Title" (.L.T "globals.terms.bounces") "Count" $d.Counts.Bounces "Key" "bounces" "Campaigns" $d.Campaigns }}
+ {{- if eq $d.Resource "lists" }}
+ {{ template "analytics-chart" dict "Title" (.L.Tc "globals.terms.subscriptions" 2) "Count" $d.Counts.Subscriptions "Key" "subscriptions" "ExtraCount" $d.Counts.Unsubscriptions "ExtraLabel" (.L.T "subscribers.status.unsubscribed") "Items" $d.Items "Resource" $d.Resource }}
+ {{- 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 }}
+ {{ template "analytics-chart" dict "Title" (.L.T "campaigns.clicks") "Count" $d.Counts.Clicks "Key" "clicks" "Items" $d.Items "Resource" $d.Resource }}
+ {{ 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">
- <h4 class="title">{{ .L.T "analytics.links" }}</h4>
- {{- if $d.Data.Links }}
- <div class="chart-box"><canvas id="chart-links"></canvas></div>
- {{- else }}
- {{- template "empty-state" }}
- {{- end }}
- </article>
+ <article class="card float">
+ <h4 class="title">{{ .L.T "analytics.links" }}</h4>
+ {{- if $d.Data.Links }}
+ <div class="chart-box"><canvas id="chart-links"></canvas></div>
+ {{- else }}
+ {{- template "empty-state" }}
+ {{- end }}
+ </article>
+ {{- end }}
{{- end }}
</div>
</section>
@@ -96,16 +102,17 @@
{{- $key := .Key -}}
<article class="card float">
<h4 class="title">{{ .Title }}{{ if gt .Count 0 }} <span class="text-lighter">({{ FormatNumber .Count }})</span>{{ end }}</h4>
- {{- if gt .Count 0 }}
+ {{- if or (gt .Count 0) (gt (.ExtraCount | default 0) 0) }}
<div class="row">
- <div class="col-9"><div class="chart-box"><canvas id="chart-{{ $key }}"></canvas></div></div>
+ <div class="col-9"><div class="chart-box"><canvas id="chart-{{ $key }}"{{ if .ExtraLabel }} data-extra-label="{{ .ExtraLabel }}"{{ end }}></canvas></div></div>
<div class="col-3 donut-container"><canvas id="chart-{{ $key }}-donut"></canvas></div>
</div>
<div id="chart-{{ $key }}-legend" class="hstack text-8 mt-2">
- {{- range $n, $c := .Campaigns }}
+ {{- range $n, $c := .Items }}
<span data-index="{{ $n }}">
<span data-marker aria-hidden="true">●</span>
- <a href="{{ URI "/admin/campaigns" }}/{{ .ID }}" class="unstyled">#{{ .ID }}: {{ .Name }}</a>: <span data-count></span>
+ <a href="{{ URI (printf "/admin/%s" $.Resource) }}/{{ .ID }}" class="unstyled">#{{ .ID }}: {{ .Name }}</a>: <span data-count></span>
+ {{- if $.ExtraLabel }} <span class="text-lighter">({{ $.ExtraLabel }}: <span data-unsubscription-count></span>)</span>{{ end }}
</span>
{{- end }}
</div>
diff --git a/static/admin/views/lists.html b/static/admin/views/lists.html
index 751bb951..fde9e275 100644
--- a/static/admin/views/lists.html
+++ b/static/admin/views/lists.html
@@ -145,6 +145,7 @@
</button>
<menu popover id="list-actions-{{ .ID }}">
<a href="{{ URI "/admin/lists" }}/{{ .ID }}" role="menuitem" class="button ghost" data-testid="btn-view">{{ Icon "eye" }} {{ $.L.T "globals.buttons.view" }}</a>
+ <a href="{{ URI "/admin/lists/analytics" }}?id={{ .ID }}" role="menuitem" class="button ghost" data-testid="btn-analytics">{{ Icon "bar-chart-2" }} {{ $.L.T "globals.terms.analytics" }}</a>
{{- if or ($d.Can "campaigns:manage" "campaigns:manage_all") ($d.CanManageList .ID) ($d.Can "subscribers:import") }}
<hr />
{{- end }}