Open source, privacy-first web analytics. Lightweight, cookie-free Google Analytics alternative. Self-hosted or cloud.
TypeScript analyticsanalytics-dashboardclickhouseelixirgoogle-analyticsmarketingopen-source-analyticsphoenixplausible-analyticspostgresqlprivacyprivacy-friendlyself-hostedsimple-analyticsstatisticstailwindcssweb-analyticswebsite-analyticswebsite-statswebsite-tracking
Add feature-flagged channels UI (#4585)
Uku Taht7a77ebf9bf59
diff --git a/assets/js/dashboard/router.tsx b/assets/js/dashboard/router.tsxindex a58028b27e..af2a67505e 100644--- a/assets/js/dashboard/router.tsx+++ b/assets/js/dashboard/router.tsx@@ -60,6 +60,11 @@ export const sourcesRoute = {element: <SourcesModal currentView="sources" />}+export const channelsRoute = {+ path: 'channels',+ element: <SourcesModal currentView="channels" />+}+export const utmMediumsRoute = {path: 'utm_mediums',element: <SourcesModal currentView="utm_mediums" />@@ -195,6 +200,7 @@ export function createAppRouter(site: PlausibleSite) {children: [{ index: true, element: <DashboardKeybinds /> },sourcesRoute,+ channelsRoute,utmMediumsRoute,utmSourcesRoute,utmCampaignsRoute,diff --git a/assets/js/dashboard/stats/modals/filter-modal.js b/assets/js/dashboard/stats/modals/filter-modal.jsindex 9139b849a4..6762b3bee3 100644--- a/assets/js/dashboard/stats/modals/filter-modal.js+++ b/assets/js/dashboard/stats/modals/filter-modal.js@@ -4,6 +4,7 @@ import { useParams } from 'react-router-dom';import Modal from './modal';import { EVENT_PROPS_PREFIX, FILTER_GROUP_TO_MODAL_TYPE, formatFilterGroup, FILTER_OPERATIONS, getFilterGroup, FILTER_MODAL_TO_FILTER_GROUP, cleanLabels } from '../../util/filters';import { useQueryContext } from '../../query-context';+import { useSiteContext } from '../../site-context';import { isModifierPressed, isTyping } from '../../keybinding';import FilterModalGroup from "./filter-modal-group";import { rootRoute } from '../../router';@@ -134,6 +135,14 @@ class FilterModal extends React.Component {})}+ getFilterGroups() {+ const groups = FILTER_MODAL_TO_FILTER_GROUP[this.props.modalType]+ if (this.props.modalType === 'source' && !this.props.site.flags.channels) {+ return groups.filter((group) => group !== 'channel')+ }+ return groups+ }+render() {return (<Modal maxWidth="460px">@@ -144,7 +153,7 @@ class FilterModal extends React.Component {<div className="mt-4 border-b border-gray-300"></div><main className="modal__content"><form className="flex flex-col" onSubmit={this.handleSubmit.bind(this)}>- {FILTER_MODAL_TO_FILTER_GROUP[this.props.modalType].map((filterGroup) => (+ {this.getFilterGroups().map((filterGroup) => (<FilterModalGroupkey={filterGroup}filterGroup={filterGroup}@@ -189,12 +198,14 @@ export default function FilterModalWithRouter(props) {const navigate = useAppNavigate();const { field } = useParams()const { query } = useQueryContext()+ const site = useSiteContext()return (<FilterModal{...props}modalType={field || 'page'}query={query}navigate={navigate}+ site={site}/>)}diff --git a/assets/js/dashboard/stats/modals/sources.js b/assets/js/dashboard/stats/modals/sources.jsindex 90242a4beb..d4be4b30b9 100644--- a/assets/js/dashboard/stats/modals/sources.js+++ b/assets/js/dashboard/stats/modals/sources.js@@ -22,6 +22,9 @@ const VIEWS = {)}},+ channels: {+ info: { title: 'Top Acquisition Channels', dimension: 'channel', endpoint: '/channels', dimensionLabel: 'Channel', defaultOrder: ["visitors", SortDirection.desc] }+ },utm_mediums: {info: { title: 'Top UTM Mediums', dimension: 'utm_medium', endpoint: '/utm_mediums', dimensionLabel: 'UTM Medium', defaultOrder: ["visitors", SortDirection.desc] }},diff --git a/assets/js/dashboard/stats/sources/source-list.js b/assets/js/dashboard/stats/sources/source-list.jsindex 70d3ee2c4e..78e4dbc2a7 100644--- a/assets/js/dashboard/stats/sources/source-list.js+++ b/assets/js/dashboard/stats/sources/source-list.js@@ -12,7 +12,7 @@ import classNames from 'classnames';import ImportedQueryUnsupportedWarning from '../imported-query-unsupported-warning';import { useQueryContext } from '../../query-context';import { useSiteContext } from '../../site-context';-import { sourcesRoute, utmCampaignsRoute, utmContentsRoute, utmMediumsRoute, utmSourcesRoute, utmTermsRoute } from '../../router';+import { sourcesRoute, channelsRoute, utmCampaignsRoute, utmContentsRoute, utmMediumsRoute, utmSourcesRoute, utmTermsRoute } from '../../router';const UTM_TAGS = {utm_medium: { label: 'UTM Medium', shortLabel: 'UTM Medium', endpoint: '/utm_mediums' },@@ -67,6 +67,41 @@ function AllSources({ afterFetchData }) {)}+function Channels({ afterFetchData }) {+ const { query } = useQueryContext();+ const site = useSiteContext();++ function fetchData() {+ return api.get(url.apiPath(site, '/channels'), query, { limit: 9 })+ }++ function getFilterFor(listItem) {+ return {+ prefix: 'channel',+ filter: ["is", "channel", [listItem['name']]]+ }+ }++ function chooseMetrics() {+ return [+ metrics.createVisitors({ meta: { plot: true } }),+ hasGoalFilter(query) && metrics.createConversionRate(),+ ].filter(metric => !!metric)+ }++ return (+ <ListReport+ fetchData={fetchData}+ afterFetchData={afterFetchData}+ getFilterFor={getFilterFor}+ keyLabel="Channel"+ metrics={chooseMetrics()}+ detailsLinkProps={{ path: channelsRoute.path, search: (search) => search }}+ color="bg-blue-50"+ />+ )+}+function UTMSources({ tab, afterFetchData }) {const { query } = useQueryContext();const site = useSiteContext();@@ -79,7 +114,7 @@ function UTMSources({ tab, afterFetchData }) {utm_content: utmContentsRoute,utm_term: utmTermsRoute,}[tab]-+function fetchData() {return api.get(url.apiPath(site, utmTag.endpoint), query, { limit: 9 })}@@ -138,6 +173,9 @@ export default function SourceList() {return (<div className="flex text-xs font-medium text-gray-500 dark:text-gray-400 space-x-2"><div className={currentTab === 'all' ? activeClass : defaultClass} onClick={setTab('all')}>All</div>+ {site.flags.channels &&+ <div className={currentTab === 'channels' ? activeClass : defaultClass} onClick={setTab('channels')}>Channels</div>+ }<Menu as="div" className="relative inline-block text-left"><div>@@ -187,6 +225,8 @@ export default function SourceList() {function renderContent() {if (currentTab === 'all') {return <AllSources afterFetchData={afterFetchData} />+ } else if (currentTab == 'channels') {+ return <Channels afterFetchData={afterFetchData} />} else {return <UTMSources tab={currentTab} afterFetchData={afterFetchData} />}diff --git a/assets/js/dashboard/util/filters.js b/assets/js/dashboard/util/filters.jsindex f1ad74f5e0..d8d13a70da 100644--- a/assets/js/dashboard/util/filters.js+++ b/assets/js/dashboard/util/filters.js@@ -6,7 +6,7 @@ import { useQueryContext } from '../query-context'export const FILTER_MODAL_TO_FILTER_GROUP = {page: ['page', 'entry_page', 'exit_page'],- source: ['source', 'referrer'],+ source: ['source', 'channel', 'referrer'],location: ['country', 'region', 'city'],screen: ['screen'],browser: ['browser', 'browser_version'],@@ -273,6 +273,7 @@ export const formattedFilters = {prop_key: 'Property',prop_value: 'Value',source: 'Source',+ channel: 'Channel',utm_medium: 'UTM Medium',utm_source: 'UTM Source',utm_campaign: 'UTM Campaign',diff --git a/lib/plausible/stats/filter_suggestions.ex b/lib/plausible/stats/filter_suggestions.exindex 53faa05c1c..dac70f87e9 100644--- a/lib/plausible/stats/filter_suggestions.ex+++ b/lib/plausible/stats/filter_suggestions.ex@@ -225,6 +225,7 @@ defmodule Plausible.Stats.FilterSuggestions do"page" -> :pathname"entry_page" -> :entry_page"source" -> :referrer_source+ "channel" -> :channel"os" -> :operating_system"os_version" -> :operating_system_version"screen" -> :screen_sizediff --git a/lib/plausible/stats/filters/filters.ex b/lib/plausible/stats/filters/filters.exindex d7650c2b2c..b296a931f6 100644--- a/lib/plausible/stats/filters/filters.ex+++ b/lib/plausible/stats/filters/filters.ex@@ -8,6 +8,7 @@ defmodule Plausible.Stats.Filters do@visit_props [:source,+ :channel,:referrer,:utm_medium,:utm_source,diff --git a/lib/plausible/stats/legacy/legacy_dimensions.ex b/lib/plausible/stats/legacy/legacy_dimensions.exindex 3de9c023af..0e4451424f 100644--- a/lib/plausible/stats/legacy/legacy_dimensions.ex+++ b/lib/plausible/stats/legacy/legacy_dimensions.ex@@ -5,6 +5,7 @@ defmodule Plausible.Stats.Legacy.Dimensions do@event_props ["event:page", "event:name", "event:goal", "event:hostname"]@session_props ["visit:source",+ "visit:channel","visit:country","visit:region","visit:city",diff --git a/lib/plausible/stats/sql/expression.ex b/lib/plausible/stats/sql/expression.exindex 4a051e0c6d..4b9d2f4a4b 100644--- a/lib/plausible/stats/sql/expression.ex+++ b/lib/plausible/stats/sql/expression.ex@@ -15,6 +15,7 @@ defmodule Plausible.Stats.SQL.Expression doalias Plausible.Stats.{Query, Filters, SQL}@no_ref "Direct / None"+ @no_channel "Direct"@not_set "(not set)"defmacrop field_or_blank_value(q, key, expr, empty_value) do@@ -149,6 +150,9 @@ defmodule Plausible.Stats.SQL.Expression dodef select_dimension(q, key, "visit:source", _table, _query),do: field_or_blank_value(q, key, t.source, @no_ref)+ def select_dimension(q, key, "visit:channel", _table, _query),+ do: field_or_blank_value(q, key, t.channel, @no_channel)+def select_dimension(q, key, "visit:referrer", _table, _query),do: field_or_blank_value(q, key, t.referrer, @no_ref)diff --git a/lib/plausible_web/controllers/api/stats_controller.ex b/lib/plausible_web/controllers/api/stats_controller.exindex 37e08b78e5..c5cd4a50ff 100644--- a/lib/plausible_web/controllers/api/stats_controller.ex+++ b/lib/plausible_web/controllers/api/stats_controller.ex@@ -518,6 +518,27 @@ defmodule PlausibleWeb.Api.StatsController doendend+ def channels(conn, params) do+ site = conn.assigns[:site]+ params = Map.put(params, "property", "visit:channel")+ query = Query.from(site, params, debug_metadata(conn))+ pagination = parse_pagination(params)++ extra_metrics =+ if params["detailed"], do: [:bounce_rate, :visit_duration], else: []++ metrics = breakdown_metrics(query, extra_metrics)++ res =+ Stats.breakdown(site, query, metrics, pagination)+ |> transform_keys(%{channel: :name})++ json(conn, %{+ results: res,+ skip_imported_reason: query.skip_imported_reason+ })+ end+on_ee dodef funnel(conn, %{"id" => funnel_id} = params) dosite = Plausible.Repo.preload(conn.assigns.site, :owner)diff --git a/lib/plausible_web/controllers/stats_controller.ex b/lib/plausible_web/controllers/stats_controller.exindex e68c6bad39..94478299ec 100644--- a/lib/plausible_web/controllers/stats_controller.ex+++ b/lib/plausible_web/controllers/stats_controller.ex@@ -364,7 +364,11 @@ defmodule PlausibleWeb.StatsController dodefp shared_link_cookie_name(slug), do: "shared-link-" <> slug- defp get_flags(_user, _site), do: %{}+ defp get_flags(user, site),+ do: %{+ channels:+ FunWithFlags.enabled?(:channels, for: user) || FunWithFlags.enabled?(:channels, for: site)+ }defp is_dbip() doon_ee dodiff --git a/lib/plausible_web/router.ex b/lib/plausible_web/router.exindex d0265df9ee..431245b804 100644--- a/lib/plausible_web/router.ex+++ b/lib/plausible_web/router.ex@@ -158,6 +158,7 @@ defmodule PlausibleWeb.Router doget "/:domain/main-graph", StatsController, :main_graphget "/:domain/top-stats", StatsController, :top_statsget "/:domain/sources", StatsController, :sources+ get "/:domain/channels", StatsController, :channelsget "/:domain/utm_mediums", StatsController, :utm_mediumsget "/:domain/utm_sources", StatsController, :utm_sourcesget "/:domain/utm_campaigns", StatsController, :utm_campaignsdiff --git a/priv/json-schemas/query-api-schema.json b/priv/json-schemas/query-api-schema.jsonindex def983a1b2..29bd780d65 100644--- a/priv/json-schemas/query-api-schema.json+++ b/priv/json-schemas/query-api-schema.json@@ -190,6 +190,7 @@"event:page","event:hostname","visit:source",+ "visit:channel","visit:referrer","visit:utm_medium","visit:utm_source",diff --git a/test/plausible_web/controllers/api/external_stats_controller/breakdown_test.exs b/test/plausible_web/controllers/api/external_stats_controller/breakdown_test.exsindex 97e462c137..eabacae754 100644--- a/test/plausible_web/controllers/api/external_stats_controller/breakdown_test.exs+++ b/test/plausible_web/controllers/api/external_stats_controller/breakdown_test.exs@@ -274,6 +274,38 @@ defmodule PlausibleWeb.Api.ExternalStatsController.BreakdownTest do}end+ test "breakdown by visit:channel", %{conn: conn, site: site} do+ populate_stats(site, [+ build(:pageview,+ channel: "Organic Search",+ timestamp: ~N[2021-01-01 00:00:00]+ ),+ build(:pageview,+ channel: "Organic Search",+ timestamp: ~N[2021-01-01 00:25:00]+ ),+ build(:pageview,+ channel: "",+ timestamp: ~N[2021-01-01 00:00:00]+ )+ ])++ conn =+ get(conn, "/api/v1/stats/breakdown", %{+ "site_id" => site.domain,+ "period" => "day",+ "date" => "2021-01-01",+ "property" => "visit:channel"+ })++ assert json_response(conn, 200) == %{+ "results" => [+ %{"channel" => "Organic Search", "visitors" => 2},+ %{"channel" => "Direct", "visitors" => 1}+ ]+ }+ end+test "breakdown by visit:country", %{conn: conn, site: site} dopopulate_stats(site, [build(:pageview, country_code: "EE", timestamp: ~N[2021-01-01 00:00:00]),diff --git a/test/plausible_web/controllers/api/external_stats_controller/query_test.exs b/test/plausible_web/controllers/api/external_stats_controller/query_test.exsindex e00c98bb8e..e3ebc0265a 100644--- a/test/plausible_web/controllers/api/external_stats_controller/query_test.exs+++ b/test/plausible_web/controllers/api/external_stats_controller/query_test.exs@@ -101,6 +101,34 @@ defmodule PlausibleWeb.Api.ExternalStatsController.QueryTest do]end+ test "can filter by channel", %{conn: conn, site: site} do+ populate_stats(site, [+ build(:pageview,+ referrer_source: "Google",+ channel: "Organic Search",+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:00:00]+ ),+ build(:pageview,+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:25:00]+ ),+ build(:pageview, timestamp: ~N[2021-01-01 00:00:00])+ ])++ conn =+ post(conn, "/api/v2/query", %{+ "site_id" => site.domain,+ "date_range" => "all",+ "metrics" => ["pageviews", "visitors", "bounce_rate", "visit_duration"],+ "filters" => [["is", "visit:channel", ["Organic Search"]]]+ })++ assert json_response(conn, 200)["results"] == [+ %{"metrics" => [2, 1, 0, 1500], "dimensions" => []}+ ]+ end+test "can filter by no source/referrer", %{conn: conn, site: site} dopopulate_stats(site, [build(:pageview,@@ -1374,6 +1402,38 @@ defmodule PlausibleWeb.Api.ExternalStatsController.QueryTest do]end+ test "breakdown by visit:channel", %{conn: conn, site: site} do+ populate_stats(site, [+ build(:pageview,+ channel: "Organic Search",+ timestamp: ~N[2021-01-01 00:00:00]+ ),+ build(:pageview,+ channel: "Organic Search",+ timestamp: ~N[2021-01-01 00:25:00]+ ),+ build(:pageview,+ channel: "",+ timestamp: ~N[2021-01-01 00:00:00]+ )+ ])++ conn =+ post(conn, "/api/v2/query", %{+ "site_id" => site.domain,+ "metrics" => ["visitors"],+ "date_range" => "all",+ "dimensions" => ["visit:channel"]+ })++ %{"results" => results} = json_response(conn, 200)++ assert results == [+ %{"dimensions" => ["Organic Search"], "metrics" => [2]},+ %{"dimensions" => ["Direct"], "metrics" => [1]}+ ]+ end+test "breakdown by visit:country", %{conn: conn, site: site} dopopulate_stats(site, [build(:pageview, country_code: "EE", timestamp: ~N[2021-01-01 00:00:00]),diff --git a/test/plausible_web/controllers/api/external_stats_controller/timeseries_test.exs b/test/plausible_web/controllers/api/external_stats_controller/timeseries_test.exsindex d03c215435..72bf6d27bd 100644--- a/test/plausible_web/controllers/api/external_stats_controller/timeseries_test.exs+++ b/test/plausible_web/controllers/api/external_stats_controller/timeseries_test.exs@@ -725,6 +725,27 @@ defmodule PlausibleWeb.Api.ExternalStatsController.TimeseriesTest doassert List.first(res["results"]) == %{"date" => "2021-01-01", "visitors" => 1}end+ test "can filter by channel", %{conn: conn, site: site} do+ populate_stats(site, [+ build(:pageview,+ channel: "Organic Search",+ timestamp: ~N[2021-01-01 00:00:00]+ ),+ build(:pageview, timestamp: ~N[2021-01-01 00:00:00])+ ])++ conn =+ get(conn, "/api/v1/stats/timeseries", %{+ "site_id" => site.domain,+ "period" => "month",+ "date" => "2021-01-01",+ "filters" => "visit:channel==Organic Search"+ })++ res = json_response(conn, 200)+ assert List.first(res["results"]) == %{"date" => "2021-01-01", "visitors" => 1}+ end+test "can filter by no source/referrer", %{conn: conn, site: site} dopopulate_stats(site, [build(:pageview, timestamp: ~N[2021-01-01 00:00:00]),diff --git a/test/plausible_web/controllers/api/stats_controller/sources_test.exs b/test/plausible_web/controllers/api/stats_controller/sources_test.exsindex 30699c50c4..ddf8cb4d28 100644--- a/test/plausible_web/controllers/api/stats_controller/sources_test.exs+++ b/test/plausible_web/controllers/api/stats_controller/sources_test.exs@@ -654,6 +654,54 @@ defmodule PlausibleWeb.Api.StatsController.SourcesTest doendend+ describe "GET /api/stats/:domain/channels" do+ setup [:create_user, :log_in, :create_new_site]++ test "returns top channels by unique user ids", %{conn: conn, site: site} do+ populate_stats(site, [+ build(:pageview,+ channel: "Organic Search",+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:00:00]+ ),+ build(:pageview,+ channel: "Organic Search",+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:15:00]+ ),+ build(:pageview,+ channel: "Paid Social",+ timestamp: ~N[2021-01-01 00:00:00]+ ),+ build(:pageview,+ channel: "Paid Social",+ timestamp: ~N[2021-01-01 00:00:00]+ )+ ])++ conn1 =+ get(+ conn,+ "/api/stats/#{site.domain}/channels?period=day&&detailed=true&date=2021-01-01"+ )++ assert json_response(conn1, 200)["results"] == [+ %{+ "name" => "Paid Social",+ "visitors" => 2,+ "bounce_rate" => 100,+ "visit_duration" => 0+ },+ %{+ "name" => "Organic Search",+ "visitors" => 1,+ "bounce_rate" => 0,+ "visit_duration" => 900+ }+ ]+ end+ end+describe "GET /api/stats/:domain/utm_mediums" dosetup [:create_user, :log_in, :create_new_site, :create_legacy_site_import]diff --git a/test/plausible_web/controllers/api/stats_controller/suggestions_test.exs b/test/plausible_web/controllers/api/stats_controller/suggestions_test.exsindex da751a90bb..b19eb631b7 100644--- a/test/plausible_web/controllers/api/stats_controller/suggestions_test.exs+++ b/test/plausible_web/controllers/api/stats_controller/suggestions_test.exs@@ -74,6 +74,25 @@ defmodule PlausibleWeb.Api.StatsController.SuggestionsTest do]end+ test "returns suggestions for channels", %{conn: conn, site: site} do+ populate_stats(site, [+ build(:pageview, timestamp: ~N[2019-01-01 23:00:00], channel: "Organic Search"),+ build(:pageview, timestamp: ~N[2019-01-01 23:00:00], channel: "Organic Search"),+ build(:pageview,+ timestamp: ~N[2019-01-01 23:00:00],+ channel: "Video"+ )+ ])++ conn =+ get(conn, "/api/stats/#{site.domain}/suggestions/channel?period=month&date=2019-01-01")++ assert json_response(conn, 200) == [+ %{"label" => "Organic Search", "value" => "Organic Search"},+ %{"label" => "Video", "value" => "Video"}+ ]+ end+test "returns suggestions for countries", %{conn: conn, site: site} dopopulate_stats(site, [build(:pageview,