Skip to content

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

Improve analytics date selection UX on campaign and list analytics.

Kailash Nadh8a65784a1e8f
diff --git a/cmd/campaign_analytics.go b/cmd/campaign_analytics.go
index b371ac44..b53adee6 100644
--- a/cmd/campaign_analytics.go
+++ b/cmd/campaign_analytics.go
@@ -79,12 +79,14 @@ func (a *App) viewAnalytics(c echo.Context, resource string) error {
}
// Resolve the date range, defaulting to the last 7 days.
- to := time.Now()
- from := to.AddDate(0, 0, -7)
- if t, ok := parseAnalyticsDate(c.QueryParam("from")); ok {
+ var (
+ to = time.Now()
+ from = to.AddDate(0, 0, -7)
+ )
+ if t, ok := ParseDateTime(c.QueryParam("from")); ok {
from = t
}
- if t, ok := parseAnalyticsDate(c.QueryParam("to")); ok {
+ if t, ok := ParseDateTime(c.QueryParam("to")); ok {
to = t
}
@@ -276,26 +278,6 @@ func (a *App) getAnalytics(c echo.Context, resource string) error {
return c.JSON(http.StatusOK, okResp{out})
}
-// parseAnalyticsDate parses a `datetime-local` form value (with or without seconds).
-func parseAnalyticsDate(s string) (time.Time, bool) {
- if s == "" {
- return time.Time{}, false
- }
-
- var layout string
- switch len(s) {
- case 16:
- layout = "2006-01-02T15:04"
- case 19:
- layout = "2006-01-02T15:04:05"
- default:
- return time.Time{}, false
- }
- t, err := time.ParseInLocation(layout, s, time.Local)
-
- return t, err == nil
-}
-
// sumAnalyticsCounts returns the total count across the given analytics rows.
func sumAnalyticsCounts(rows []models.CampaignAnalyticsCount) int {
total := 0
diff --git a/cmd/utils.go b/cmd/utils.go
index 4b9b0f4a..49588e6f 100644
--- a/cmd/utils.go
+++ b/cmd/utils.go
@@ -193,3 +193,25 @@ func formatTimestamps(from, to, now time.Time) string {
}
return from.Format(startLayout) + " - " + to.Format(endLayout)
}
+
+// ParseDateTime parses datetime formats.
+func ParseDateTime(s string) (time.Time, bool) {
+ if s == "" {
+ return time.Time{}, false
+ }
+
+ var layout string
+ switch len(s) {
+ case 10:
+ layout = "2006-01-02"
+ case 16:
+ layout = "2006-01-02T15:04"
+ case 19:
+ layout = "2006-01-02T15:04:05"
+ default:
+ return time.Time{}, false
+ }
+ t, err := time.ParseInLocation(layout, s, time.Local)
+
+ return t, err == nil
+}
diff --git a/i18n/en.json b/i18n/en.json
index f0a58a10..fa7cf4df 100644
--- a/i18n/en.json
+++ b/i18n/en.json
@@ -282,6 +282,7 @@
"globals.terms.none": "None",
"globals.terms.page": "Page {n}",
"globals.terms.recent": "Recent {name}",
+ "globals.terms.range": "Range",
"globals.terms.second": "Second | Seconds",
"globals.terms.settings": "Settings",
"globals.terms.subscriber": "Subscriber | Subscribers",
diff --git a/static/admin/assets/css/style.css b/static/admin/assets/css/style.css
index edc1fe4f..8af37142 100644
--- a/static/admin/assets/css/style.css
+++ b/static/admin/assets/css/style.css
@@ -1527,6 +1527,16 @@ section.templates {
/* Analytics */
section.analytics {
+ .analytics-dates {
+ width: min(90vw, 20rem);
+ max-height: 90vh;
+ overflow-y: auto;
+
+ .custom-dates {
+ padding: var(--space-3);
+ }
+ }
+
.chart-box,
.donut-container {
position: relative;
diff --git a/static/admin/assets/js/views/analytics.js b/static/admin/assets/js/views/analytics.js
index fcdb75fb..2e4e2a41 100644
--- a/static/admin/assets/js/views/analytics.js
+++ b/static/admin/assets/js/views/analytics.js
@@ -125,7 +125,7 @@ class AnalyticsTag {
}
// analyticsForm is the Alpine component for the analytics page.
-function analyticsForm() {
+function analyticsForm(from, to) {
let queryTimer = null;
return {
@@ -134,6 +134,38 @@ function analyticsForm() {
// Set on submit to give feedback during the full-page reload.
submitting: false,
+ from,
+ to,
+
+ get rangeLabel() {
+ return [this.from, this.to]
+ .map((value) => value ? value.slice(0, 16).replace('T', ' ') : '…')
+ .join(' – ');
+ },
+
+ onDateRange(amount, unit) {
+ const to = new Date();
+ const from = new Date(to);
+ if (unit === 'month') {
+ // Clamp to the last day when the target month is short.
+ from.setDate(1);
+ from.setMonth(from.getMonth() - amount);
+
+ const lastDay = new Date(from.getFullYear(), from.getMonth() + 1, 0).getDate();
+ from.setDate(Math.min(to.getDate(), lastDay));
+ } else if (unit === 'day') {
+ from.setDate(from.getDate() - amount);
+ } else {
+ from.setTime(from.getTime() - amount * 60 * 60 * 1000);
+ }
+
+ const localDate = (date) => new Date(date.getTime() - date.getTimezoneOffset() * 60000).toISOString().slice(0, 16);
+ this.from = localDate(from);
+ this.to = localDate(to);
+ this.$refs.dates.hidePopover();
+ this.$nextTick(() => this.$root.requestSubmit());
+ },
+
// Populate the selector's suggestions with the resource API.
onQuery(el) {
clearTimeout(queryTimer);
diff --git a/static/admin/partials/analytics-date-range.html b/static/admin/partials/analytics-date-range.html
new file mode 100644
index 00000000..8e27b681
--- /dev/null
+++ b/static/admin/partials/analytics-date-range.html
@@ -0,0 +1,23 @@
+{{ define "analytics-date-range" -}}
+<label>{{ .L.T "globals.terms.range" }}</label>
+<ot-dropdown>
+ <button type="button" class="outline" popovertarget="analytics-dates" data-cy="date-range"><span x-text="rangeLabel"></span> {{ Icon "chevron-down" }}</button>
+ <div popover id="analytics-dates" class="analytics-dates" x-ref="dates">
+ <button type="button" role="menuitem" class="ghost" @click="onDateRange(24, 'hour')" :disabled="submitting">24 {{ .L.Tc "globals.terms.hour" 24 }}</button>
+ <button type="button" role="menuitem" class="ghost" @click="onDateRange(7, 'day')" :disabled="submitting">7 {{ .L.Tc "globals.terms.day" 7 }}</button>
+ <button type="button" role="menuitem" class="ghost" @click="onDateRange(30, 'day')" :disabled="submitting">30 {{ .L.Tc "globals.terms.day" 30 }}</button>
+ <button type="button" role="menuitem" class="ghost" @click="onDateRange(6, 'month')" :disabled="submitting">6 {{ .L.Tc "globals.terms.month" 6 }}</button>
+ <button type="button" role="menuitem" class="ghost" @click="onDateRange(12, 'month')" :disabled="submitting">12 {{ .L.Tc "globals.terms.month" 12 }}</button>
+ <hr />
+ <div class="custom-dates">
+ <label data-field>{{ .L.T "analytics.fromDate" }}
+ <input type="datetime-local" name="from" x-model="from" data-cy="from" required />
+ </label>
+ <label data-field>{{ .L.T "analytics.toDate" }}
+ <input type="datetime-local" name="to" x-model="to" data-cy="to" :min="from" required />
+ </label>
+ <button type="submit" data-variant="secondary" :disabled="submitting">{{ .L.T "globals.buttons.apply" }}</button>
+ </div>
+ </div>
+</ot-dropdown>
+{{- end }}
diff --git a/static/admin/partials/campaigns-table.html b/static/admin/partials/campaigns-table.html
index 262e5d01..e711bcb2 100644
--- a/static/admin/partials/campaigns-table.html
+++ b/static/admin/partials/campaigns-table.html
@@ -4,6 +4,7 @@
{{- $readonly := .Readonly -}}
{{- $base := URI "/admin/campaigns" -}}
{{- $tableBase := .Base -}}
+{{- $defaultAnalyticsDate := now.AddDate 0 0 -30 -}}
<div class="table-wrapper" x-data="table({ query: {{ ToJSON $d.Page.Query }}, filters: {{ ToJSON $d.Page.QueryParams }}, total: {{ $d.Page.Total }} })" :aria-busy="isLoading('campaigns')" @change="onChange($event)">
{{- if .ClearFilters }}
<div class="bulk-actions">
@@ -178,7 +179,9 @@
<button type="button" role="menuitem" class="ghost" data-cy="btn-clone" @click.prevent="onClone({{ .ID }}, {{ ToJSON .Name }})">{{ Icon "copy" }} {{ $root.L.T "globals.buttons.clone" }}</button>
{{- end }}
{{- if $d.Can "campaigns:get_analytics" }}
- <a href="{{ URI "/admin/campaigns/analytics" }}?id={{ .ID }}" role="menuitem" class="button ghost" data-cy="btn-analytics">{{ Icon "bar-chart-2" }} {{ $root.L.T "globals.terms.analytics" }}</a>
+ {{- $from := $defaultAnalyticsDate -}}
+ {{- if .StartedAt.Valid }}{{ $from = .StartedAt.Time.Local }}{{ end -}}
+ <a href="{{ URI "/admin/campaigns/analytics" }}?id={{ .ID }}&from={{ $from.Format "2006-01-02" }}" role="menuitem" class="button ghost" data-cy="btn-analytics">{{ Icon "bar-chart-2" }} {{ $root.L.T "globals.terms.analytics" }}</a>
{{- end }}
{{- if and (not $readonly) ($d.Can "campaigns:manage" "campaigns:manage_all") }}
<hr />
diff --git a/static/admin/partials/sidebar.html b/static/admin/partials/sidebar.html
index 15aebc65..523b0f9e 100644
--- a/static/admin/partials/sidebar.html
+++ b/static/admin/partials/sidebar.html
@@ -13,7 +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/analytics" }}?from={{ (now.AddDate 0 -3 0).Format "2006-01-02" }}" {{ 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 82ea30aa..bb04b0e5 100644
--- a/static/admin/views/analytics.html
+++ b/static/admin/views/analytics.html
@@ -15,11 +15,11 @@
</header>
<div class="vstack gap-6">
- <form method="get" action="{{ URI (printf "/admin/%s/analytics" $d.Resource) }}" x-data="analyticsForm()" @submit="submitting = true">
+ <form method="get" action="{{ URI (printf "/admin/%s/analytics" $d.Resource) }}" x-data="analyticsForm({{ ToJSON $d.FromInput }}, {{ ToJSON $d.ToInput }})" @submit="submitting = true">
<div class="card float">
<h4 class="title">{{ .L.T "analytics.title" }}</h4>
<div class="row">
- <div class="col-4">
+ <div class="col-5">
<label data-field>
{{ .L.T (printf "globals.terms.%s" $d.Resource) }}
<ot-taginput x-model="items">
@@ -32,13 +32,9 @@
</template>
</div>
- <div class="col-5">
+ <div class="col-4">
<data data-field>
- <label>{{ .L.T "analytics.fromDate" }} &rarr; {{ .L.T "analytics.toDate" }}</label>
- <fieldset class="group">
- <input type="datetime-local" name="from" value="{{ $d.FromInput }}" aria-label="{{ .L.T "analytics.fromDate" }}" data-cy="from" />
- <input type="datetime-local" name="to" value="{{ $d.ToInput }}" aria-label="{{ .L.T "analytics.toDate" }}" data-cy="to" />
- </fieldset>
+ {{ template "analytics-date-range" . }}
{{- if $d.DisableTracking }}
<span data-hint>{{ Icon "alert-triangle" }} {{ .L.T "analytics.trackingDisabled" }}</span>
{{- end }}
diff --git a/static/admin/views/dashboard.html b/static/admin/views/dashboard.html
index 868903a0..50ace15f 100644
--- a/static/admin/views/dashboard.html
+++ b/static/admin/views/dashboard.html
@@ -96,7 +96,9 @@
</td>
<td class="actions align-right">
{{- if $d.Can "campaigns:get_analytics" }}
- <a href="{{ URI "/admin/campaigns/analytics" }}?id={{ .ID }}" title="{{ $.L.T "globals.terms.analytics" }}">{{ Icon "bar-chart-2" }}</a>
+ {{- $from := now.AddDate 0 0 -30 -}}
+ {{- if .StartedAt.Valid }}{{ $from = .StartedAt.Time.Local }}{{ end -}}
+ <a href="{{ URI "/admin/campaigns/analytics" }}?id={{ .ID }}&from={{ $from.Format "2006-01-02" }}" title="{{ $.L.T "globals.terms.analytics" }}">{{ Icon "bar-chart-2" }}</a>
{{- end }}
</td>
</tr>
diff --git a/static/admin/views/lists.html b/static/admin/views/lists.html
index fde9e275..041d3b51 100644
--- a/static/admin/views/lists.html
+++ b/static/admin/views/lists.html
@@ -145,7 +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>
+ <a href="{{ URI "/admin/lists/analytics" }}?id={{ .ID }}&from={{ (now.AddDate 0 -3 0).Format "2006-01-02" }}" 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 }}