Skip to content

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

Add ability to export campaign clicks/views from the Maintenance admin UI.

Kailash Nadhcb19ceba9df8
diff --git a/cmd/handlers.go b/cmd/handlers.go
index ecc27639..cc9311a9 100644
--- a/cmd/handlers.go
+++ b/cmd/handlers.go
@@ -191,6 +191,7 @@ func initHTTPHandlers(e *echo.Echo, a *App) {
g.DELETE("/api/maintenance/subscribers/:type", pm(a.GCSubscribers, "settings:maintain"))
g.DELETE("/api/maintenance/analytics/:type", pm(a.GCCampaignAnalytics, "settings:maintain"))
+ g.GET("/api/maintenance/analytics/:type/export", pm(a.ExportCampaignAnalytics, "settings:maintain"))
g.DELETE("/api/maintenance/subscriptions/unconfirmed", pm(a.GCSubscriptions, "settings:maintain"))
g.POST("/api/tx", pm(a.SendTxMessage, "tx:send"))
diff --git a/cmd/maintenance.go b/cmd/maintenance.go
index 2a8d8395..bf10ac60 100644
--- a/cmd/maintenance.go
+++ b/cmd/maintenance.go
@@ -1,8 +1,10 @@
package main
import (
+ "encoding/csv"
"log"
"net/http"
+ "strconv"
"time"
"github.com/jmoiron/sqlx"
@@ -84,6 +86,79 @@ func (a *App) GCCampaignAnalytics(c echo.Context) error {
return c.JSON(http.StatusOK, okResp{true})
}
+// ExportCampaignAnalytics streams campaign analytics (views or link clicks) as a CSV file.
+func (a *App) ExportCampaignAnalytics(c echo.Context) error {
+ since, err := time.Parse(time.RFC3339, c.QueryParam("since"))
+ if err != nil {
+ return echo.NewHTTPError(http.StatusBadRequest, a.i18n.T("globals.messages.invalidData"))
+ }
+
+ typ := c.Param("type")
+ if typ != "views" && typ != "clicks" {
+ return echo.NewHTTPError(http.StatusBadRequest, a.i18n.T("globals.messages.invalidData"))
+ }
+
+ var (
+ hdr = c.Response().Header()
+ wr = csv.NewWriter(c.Response())
+ )
+ hdr.Set(echo.HeaderContentType, "text/csv")
+ hdr.Set(echo.HeaderContentDisposition, "attachment; filename=campaign_"+typ+".csv")
+ hdr.Set("Cache-Control", "no-cache")
+
+ switch typ {
+ case "views":
+ wr.Write([]string{"campaign_id", "campaign_uuid", "campaign_name", "subscriber_id", "subscriber_uuid", "email", "subscriber_name", "created_at"})
+ next := a.core.ExportCampaignViews(since, a.cfg.DBBatchSize)
+ for {
+ rows, err := next()
+ if err != nil {
+ return err
+ }
+ if len(rows) == 0 {
+ break
+ }
+ for _, r := range rows {
+ if err := wr.Write([]string{
+ strconv.Itoa(r.CampaignID), r.CampaignUUID, r.CampaignName,
+ strconv.Itoa(r.SubscriberID), r.SubscriberUUID, r.Email, r.SubscriberName,
+ r.CreatedAt.Format(time.RFC3339),
+ }); err != nil {
+ a.log.Printf("error streaming CSV: %v", err)
+ return nil
+ }
+ }
+ wr.Flush()
+ }
+
+ case "clicks":
+ wr.Write([]string{"campaign_id", "campaign_uuid", "campaign_name", "subscriber_id", "subscriber_uuid", "email", "subscriber_name", "url", "created_at"})
+ next := a.core.ExportCampaignLinkClicks(since, a.cfg.DBBatchSize)
+ for {
+ rows, err := next()
+ if err != nil {
+ return err
+ }
+ if len(rows) == 0 {
+ break
+ }
+ for _, r := range rows {
+ if err := wr.Write([]string{
+ strconv.Itoa(r.CampaignID), r.CampaignUUID, r.CampaignName,
+ strconv.Itoa(r.SubscriberID), r.SubscriberUUID, r.Email, r.SubscriberName, r.URL,
+ r.CreatedAt.Format(time.RFC3339),
+ }); err != nil {
+ a.log.Printf("error streaming CSV: %v", err)
+ return nil
+ }
+ }
+ wr.Flush()
+ }
+ }
+
+ return nil
+}
+
// RunDBVacuum runs a full VACUUM on the PostgreSQL database.
// VACUUM reclaims storage occupied by dead tuples and updates planner statistics.
func RunDBVacuum(db *sqlx.DB, lo *log.Logger) {
diff --git a/frontend/src/views/Maintenance.vue b/frontend/src/views/Maintenance.vue
index fdeed2a2..9ce8375f 100644
--- a/frontend/src/views/Maintenance.vue
+++ b/frontend/src/views/Maintenance.vue
@@ -106,6 +106,42 @@
</b-field>
</div>
</div>
+
+ <hr />
+ <h5 class="is-size-5">
+ {{ $t('subscribers.export') }}
+ </h5>
+ <br />
+ <div class="columns">
+ <div class="column is-4">
+ <b-field label="Data">
+ <b-select v-model="exportType" expanded>
+ <option value="views">
+ {{ $t('dashboard.campaignViews') }}
+ </option>
+ <option value="clicks">
+ {{ $t('dashboard.linkClicks') }}
+ </option>
+ </b-select>
+ </b-field>
+ </div>
+ <div class="column is-4">
+ <b-field :label="$t('analytics.fromDate')">
+ <b-datepicker v-model="exportDate" required expanded icon="calendar-clock"
+ :date-formatter="formatDateTime" />
+ </b-field>
+ </div>
+ <div class="column is-1" />
+ <div class="column">
+ <br />
+ <b-field>
+ <b-button expanded class="is-primary" tag="a" icon-left="download"
+ :href="exportURL">
+ {{ $t('subscribers.export') }}
+ </b-button>
+ </b-field>
+ </div>
+ </div>
</div><!-- analytics -->
<form @submit.prevent="onUpdateDBSettings" class="box mt-6">
@@ -160,6 +196,8 @@ export default Vue.extend({
subscriptionType: 'optin',
analyticsDate: dayjs().subtract(7, 'day').toDate(),
subscriptionDate: dayjs().subtract(7, 'day').toDate(),
+ exportType: 'views',
+ exportDate: dayjs().subtract(30, 'day').toDate(),
dbSettings: {
vacuum: false,
vacuum_cron_interval: '0 2 * * *',
@@ -234,6 +272,11 @@ export default Vue.extend({
computed: {
...mapState(['loading']),
+
+ exportURL() {
+ const since = encodeURIComponent(dayjs(this.exportDate).toISOString());
+ return `/api/maintenance/analytics/${this.exportType}/export?since=${since}`;
+ },
},
});
diff --git a/internal/core/campaigns.go b/internal/core/campaigns.go
index 914b0c70..65c9509a 100644
--- a/internal/core/campaigns.go
+++ b/internal/core/campaigns.go
@@ -460,6 +460,36 @@ func (c *Core) RegisterCampaignLinkClick(linkUUID, campUUID, subUUID string) (st
return url, nil
}
+// ExportCampaignViews returns an iterator with campaign views for streaming/exporting.
+func (c *Core) ExportCampaignViews(since time.Time, batchSize int) func() ([]models.CampaignViewExport, error) {
+ offset := 0
+ return func() ([]models.CampaignViewExport, error) {
+ var out []models.CampaignViewExport
+ if err := c.q.ExportCampaignViews.Select(&out, since, batchSize, offset); err != nil {
+ c.log.Printf("error exporting campaign views: %v", err)
+ return nil, echo.NewHTTPError(http.StatusInternalServerError,
+ c.i18n.Ts("globals.messages.errorFetching", "name", "{globals.terms.analytics}", "error", pqErrMsg(err)))
+ }
+ offset += len(out)
+ return out, nil
+ }
+}
+
+// ExportCampaignLinkClicks returns an iterator with campaign link click for streaming/exporting.
+func (c *Core) ExportCampaignLinkClicks(since time.Time, batchSize int) func() ([]models.CampaignClickExport, error) {
+ offset := 0
+ return func() ([]models.CampaignClickExport, error) {
+ var out []models.CampaignClickExport
+ if err := c.q.ExportCampaignLinkClicks.Select(&out, since, batchSize, offset); err != nil {
+ c.log.Printf("error exporting campaign link clicks: %v", err)
+ return nil, echo.NewHTTPError(http.StatusInternalServerError,
+ c.i18n.Ts("globals.messages.errorFetching", "name", "{globals.terms.analytics}", "error", pqErrMsg(err)))
+ }
+ offset += len(out)
+ return out, nil
+ }
+}
+
// DeleteCampaignViews deletes campaign views older than a given date.
func (c *Core) DeleteCampaignViews(before time.Time) error {
if _, err := c.q.DeleteCampaignViews.Exec(before); err != nil {
diff --git a/models/queries.go b/models/queries.go
index b4cf942c..d891b4cb 100644
--- a/models/queries.go
+++ b/models/queries.go
@@ -77,6 +77,8 @@ type Queries struct {
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"`
NextCampaigns *sqlx.Stmt `query:"next-campaigns"`
GetRunningCampaign *sqlx.Stmt `query:"get-running-campaign"`
diff --git a/models/templates.go b/models/templates.go
index 2ab1fa23..b203ec32 100644
--- a/models/templates.go
+++ b/models/templates.go
@@ -79,3 +79,26 @@ type CampaignAnalyticsLink struct {
URL string `db:"url" json:"url"`
Count int `db:"count" json:"count"`
}
+
+type CampaignViewExport struct {
+ CampaignID int `db:"campaign_id"`
+ CampaignUUID string `db:"campaign_uuid"`
+ CampaignName string `db:"campaign_name"`
+ SubscriberID int `db:"subscriber_id"`
+ SubscriberUUID string `db:"subscriber_uuid"`
+ Email string `db:"email"`
+ SubscriberName string `db:"subscriber_name"`
+ CreatedAt time.Time `db:"created_at"`
+}
+
+type CampaignClickExport struct {
+ CampaignID int `db:"campaign_id"`
+ CampaignUUID string `db:"campaign_uuid"`
+ CampaignName string `db:"campaign_name"`
+ SubscriberID int `db:"subscriber_id"`
+ SubscriberUUID string `db:"subscriber_uuid"`
+ Email string `db:"email"`
+ SubscriberName string `db:"subscriber_name"`
+ URL string `db:"url"`
+ CreatedAt time.Time `db:"created_at"`
+}
diff --git a/queries/campaigns.sql b/queries/campaigns.sql
index 86fcde28..6430021a 100644
--- a/queries/campaigns.sql
+++ b/queries/campaigns.sql
@@ -275,6 +275,37 @@ SELECT COUNT(%s) AS "count", url
WHERE campaign_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: export-campaign-views
+SELECT campaign_views.campaign_id,
+ COALESCE(campaigns.uuid::TEXT, '') AS campaign_uuid,
+ COALESCE(campaigns.name, '') AS campaign_name,
+ COALESCE(campaign_views.subscriber_id, 0) AS subscriber_id,
+ COALESCE(subscribers.uuid::TEXT, '') AS subscriber_uuid,
+ COALESCE(subscribers.email, '') AS email,
+ COALESCE(subscribers.name, '') AS subscriber_name,
+ campaign_views.created_at
+ FROM campaign_views
+ LEFT JOIN campaigns ON (campaigns.id = campaign_views.campaign_id)
+ LEFT JOIN subscribers ON (subscribers.id = campaign_views.subscriber_id)
+ WHERE campaign_views.created_at >= $1
+ ORDER BY campaign_views.id ASC LIMIT $2 OFFSET $3;
+
+-- name: export-campaign-link-clicks
+SELECT link_clicks.campaign_id,
+ COALESCE(campaigns.uuid::TEXT, '') AS campaign_uuid,
+ COALESCE(campaigns.name, '') AS campaign_name,
+ COALESCE(link_clicks.subscriber_id, 0) AS subscriber_id,
+ COALESCE(subscribers.uuid::TEXT, '') AS subscriber_uuid,
+ COALESCE(subscribers.email, '') AS email,
+ COALESCE(subscribers.name, '') AS subscriber_name,
+ links.url, link_clicks.created_at
+ FROM link_clicks
+ LEFT JOIN campaigns ON (campaigns.id = link_clicks.campaign_id)
+ LEFT JOIN links ON (links.id = link_clicks.link_id)
+ LEFT JOIN subscribers ON (subscribers.id = link_clicks.subscriber_id)
+ WHERE link_clicks.created_at >= $1
+ ORDER BY link_clicks.id ASC LIMIT $2 OFFSET $3;
+
-- name: get-running-campaign
-- Returns the metadata for a running campaign that is required by next-campaign-subscribers to retrieve
-- a batch of campaign subscribers for processing.