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
Exploration direction (#6247)
Adam Rutkowskieeaaace7d24d
diff --git a/assets/js/dashboard/stats/exploration.js b/assets/js/dashboard/stats/exploration.jsindex 0cd6e9269f..31921e8a85 100644--- a/assets/js/dashboard/stats/exploration.js+++ b/assets/js/dashboard/stats/exploration.js@@ -7,29 +7,47 @@ import { useDashboardStateContext } from '../dashboard-state-context'import { numberShortFormatter } from '../util/number-formatter'const PAGE_FILTER_KEYS = ['page', 'entry_page', 'exit_page']+const EXPLORATION_DIRECTIONS = {+ FORWARD: 'forward',+ BACKWARD: 'backward'+}-function fetchColumnData(site, dashboardState, steps, filter) {- // Page filters only apply to the first step — strip them for subsequent columns- const stateToUse =- steps.length > 0- ? {- ...dashboardState,- filters: dashboardState.filters.filter(- ([_op, key]) => !PAGE_FILTER_KEYS.includes(key)- )- }- : dashboardState+function stateWithApplicableFilters(dashboardState, steps) {+ if (steps.length === 0) {+ return dashboardState+ }- const journey = []- if (steps.length > 0) {- for (const s of steps) {- journey.push({ name: s.name, pathname: s.pathname })- }+ return {+ ...dashboardState,+ filters: dashboardState.filters.filter(+ ([_op, key]) => !PAGE_FILTER_KEYS.includes(key)+ )}+}++function toJourney(steps) {+ return steps.map((s) => ({ name: s.name, pathname: s.pathname }))+}++function fetchColumnData(site, dashboardState, steps, filter, direction) {+ // Page filters only apply to the first step — strip them for subsequent columns+ const stateToUse = stateWithApplicableFilters(dashboardState, steps)+ const journey = toJourney(steps)return api.get(url.apiPath(site, '/exploration/next'), stateToUse, {journey: JSON.stringify(journey),- search_term: filter+ search_term: filter,+ direction+ })+}++function fetchFunnelData(site, dashboardState, steps, direction) {+ const stateToUse = stateWithApplicableFilters(dashboardState, steps)+ const journey = toJourney(steps)++ return api.get(url.apiPath(site, '/exploration/funnel'), stateToUse, {+ journey: JSON.stringify(journey),+ direction})}@@ -37,13 +55,19 @@ function ExplorationColumn({header,steps,selected,+ selectedVisitors,onSelect,- dashboardState+ dashboardState,+ direction}) {const site = useSiteContext()const [loading, setLoading] = useState(steps !== null)const [results, setResults] = useState([])const [filter, setFilter] = useState('')+ const stepsFingerprint =+ steps === null+ ? null+ : steps.map((step) => `${step.name}:${step.pathname}`).join(';')const debouncedOnSearchInputChange = useDebounce((event) =>setFilter(event.target.value)@@ -64,18 +88,30 @@ function ExplorationColumn({setLoading(true)setResults([])- fetchColumnData(site, dashboardState, steps, filter)+ let cancelled = false++ fetchColumnData(site, dashboardState, steps, filter, direction).then((response) => {- setResults(response || [])+ if (!cancelled) {+ setResults(response || [])+ }}).catch(() => {- setResults([])+ if (!cancelled) {+ setResults([])+ }}).finally(() => {- setLoading(false)+ if (!cancelled) {+ setLoading(false)+ }})++ return () => {+ cancelled = true+ }// eslint-disable-next-line react-hooks/exhaustive-deps- }, [dashboardState, steps, filter])+ }, [dashboardState, stepsFingerprint, filter, direction, site, selected])const maxVisitors = results.length > 0 ? results[0].visitors : 1@@ -126,11 +162,15 @@ function ExplorationColumn({: results.slice(0, 10)).map(({ step, visitors }) => {const label = `${step.name} ${step.pathname}`- const pct = Math.round((visitors / maxVisitors) * 100)const isSelected =!!selected &&step.name === selected.name &&step.pathname === selected.pathname+ const visitorsToShow =+ isSelected && selectedVisitors !== null+ ? selectedVisitors+ : visitors+ const pct = Math.round((visitorsToShow / maxVisitors) * 100)return (<li key={label}>@@ -154,7 +194,7 @@ function ExplorationColumn({{label}</span><span className="ml-2 shrink-0 text-gray-500 dark:text-gray-400 tabular-nums">- {numberShortFormatter(visitors)}+ {numberShortFormatter(visitorsToShow)}</span></div><div className="h-1 rounded-full bg-gray-100 dark:bg-gray-700 overflow-hidden">@@ -177,14 +217,22 @@ function ExplorationColumn({)}-function columnHeader(index) {- if (index === 0) return 'Start'- return `${index} step${index === 1 ? '' : 's'} after`+function columnHeader(index, direction) {+ if (index === 0) {+ return direction === EXPLORATION_DIRECTIONS.BACKWARD ? 'End' : 'Start'+ }++ return `${index} step${index === 1 ? '' : 's'} ${+ direction === EXPLORATION_DIRECTIONS.BACKWARD ? 'before' : 'after'+ }`}export function FunnelExploration() {+ const site = useSiteContext()const { dashboardState } = useDashboardStateContext()const [steps, setSteps] = useState([])+ const [direction, setDirection] = useState(EXPLORATION_DIRECTIONS.FORWARD)+ const [funnel, setFunnel] = useState([])function handleSelect(columnIndex, selected) {if (selected === null) {@@ -194,22 +242,86 @@ export function FunnelExploration() {}}+ function handleDirectionSelect(nextDirection) {+ if (nextDirection === direction) return+ setDirection(nextDirection)+ setSteps([])+ setFunnel([])+ }++ useEffect(() => {+ if (steps.length === 0) {+ setFunnel([])+ return+ }++ let cancelled = false++ fetchFunnelData(site, dashboardState, steps, direction)+ .then((response) => {+ if (!cancelled) {+ setFunnel(response || [])+ }+ })+ .catch(() => {+ if (!cancelled) {+ setFunnel([])+ }+ })++ return () => {+ cancelled = true+ }+ }, [site, dashboardState, steps, direction])+const numColumns = Math.max(steps.length + 1, 3)return (<div className="p-4">- <h4 className="mt-2 mb-4 text-base font-semibold dark:text-gray-100">- Explore user journeys- </h4>- <div className="flex gap-3">+ <div className="mt-2 mb-4 flex flex-wrap items-center justify-between gap-3">+ <h4 className="text-base font-semibold dark:text-gray-100">+ Explore user journeys+ </h4>+ <div className="flex shrink-0 rounded-md border border-gray-200 dark:border-gray-700 overflow-hidden">+ <button+ onClick={() =>+ handleDirectionSelect(EXPLORATION_DIRECTIONS.FORWARD)+ }+ className={`px-3 py-1 text-xs font-semibold transition-colors ${+ direction === EXPLORATION_DIRECTIONS.FORWARD+ ? 'bg-indigo-500 text-white'+ : 'bg-white dark:bg-gray-800 text-gray-600 dark:text-gray-300'+ }`}+ >+ Forward+ </button>+ <button+ onClick={() =>+ handleDirectionSelect(EXPLORATION_DIRECTIONS.BACKWARD)+ }+ className={`px-3 py-1 text-xs font-semibold transition-colors border-l border-gray-200 dark:border-gray-700 ${+ direction === EXPLORATION_DIRECTIONS.BACKWARD+ ? 'bg-indigo-500 text-white'+ : 'bg-white dark:bg-gray-800 text-gray-600 dark:text-gray-300'+ }`}+ >+ Backward+ </button>+ </div>+ </div>+ <div+ className={`flex gap-3 ${direction === 'backward' ? 'flex-row-reverse' : ''}`}+ >{Array.from({ length: numColumns }, (_, i) => (<ExplorationColumnkey={i}- header={columnHeader(i)}+ header={columnHeader(i, direction)}steps={steps.length >= i ? steps.slice(0, i) : null}selected={steps[i] || null}+ selectedVisitors={funnel[i]?.visitors ?? null}onSelect={(selected) => handleSelect(i, selected)}dashboardState={dashboardState}+ direction={direction}/>))}</div>diff --git a/lib/plausible/stats/exploration.ex b/lib/plausible/stats/exploration.exindex 3c5f702c86..31da9ff26d 100644--- a/lib/plausible/stats/exploration.ex+++ b/lib/plausible/stats/exploration.ex@@ -21,6 +21,9 @@ defmodule Plausible.Stats.Exploration doalias Plausible.Stats.Query@type journey() :: [Journey.Step.t()]+ @type direction() :: :forward | :backward++ defguard is_direction(value) when value in [:forward, :backward]@type next_step() :: %{step: Journey.Step.t(),@@ -34,32 +37,38 @@ defmodule Plausible.Stats.Exploration dodropoff_percentage: String.t()}- @spec next_steps(Query.t(), journey(), String.t()) ::+ @spec next_steps(Query.t(), journey(), String.t(), direction()) ::{:ok, [next_step()]}- def next_steps(query, journey, search_term \\ "") do+ def next_steps(query, journey, search_term \\ "", direction \\ :forward)+ when is_direction(direction) doquery|> Base.base_event_query()- |> next_steps_query(journey, search_term)+ |> next_steps_query(journey, search_term, direction)|> ClickhouseRepo.all()|> then(&{:ok, &1})end- @spec journey_funnel(Query.t(), journey()) ::+ @spec journey_funnel(Query.t(), journey(), direction()) ::{:ok, [funnel_step()]} | {:error, :empty_journey}- def journey_funnel(_query, []), do: {:error, :empty_journey}+ def journey_funnel(query, journey, direction \\ :forward)++ def journey_funnel(_query, [], _direction), do: {:error, :empty_journey}++ def journey_funnel(query, journey, direction) when is_direction(direction) do+ journey_for_query = journey_for_query(journey, direction)- def journey_funnel(query, journey) doquery|> Base.base_event_query()- |> journey_funnel_query(journey)+ |> journey_funnel_query(journey_for_query)|> ClickhouseRepo.all()- |> to_funnel(journey)+ |> to_funnel(journey_for_query)+ |> maybe_reverse_funnel(direction)|> then(&{:ok, &1})end- defp next_steps_query(query, steps, search_term) do+ defp next_steps_query(query, steps, search_term, direction) donext_step_idx = length(steps) + 1- q_steps = steps_query(query, next_step_idx)+ q_steps = steps_query(query, next_step_idx, direction)next_name = :"name#{next_step_idx}"next_pathname = :"pathname#{next_step_idx}"@@ -97,7 +106,7 @@ defmodule Plausible.Stats.Exploration doenddefp journey_funnel_query(query, steps) do- q_steps = steps_query(query, length(steps))+ q_steps = steps_query(query, length(steps), :forward)[first_step | steps] = steps@@ -129,10 +138,16 @@ defmodule Plausible.Stats.Exploration doend)end- defp steps_query(query, steps) when is_integer(steps) do+ defp steps_query(query, steps, direction) when is_integer(steps) do+ event_ordering =+ case direction do+ :backward -> [desc: :timestamp]+ _ -> [asc: :timestamp]+ end+q_steps =from(e in query,- windows: [step_window: [partition_by: e.user_id, order_by: e.timestamp]],+ windows: [step_window: [partition_by: e.user_id, order_by: ^event_ordering]],select: %{user_id: e.user_id,_sample_factor: e._sample_factor,@@ -140,7 +155,7 @@ defmodule Plausible.Stats.Exploration dopathname1: e.pathname},where: e.name != "engagement",- order_by: e.timestamp+ order_by: ^event_ordering)if steps > 1 do@@ -205,4 +220,10 @@ defmodule Plausible.Stats.Exploration do|> Map.fetch!(:funnel)|> Enum.reverse()end++ defp journey_for_query(journey, :backward), do: Enum.reverse(journey)+ defp journey_for_query(journey, :forward), do: journey++ defp maybe_reverse_funnel(funnel, :backward), do: Enum.reverse(funnel)+ defp maybe_reverse_funnel(funnel, :forward), do: funnelenddiff --git a/lib/plausible_web/controllers/api/stats_controller.ex b/lib/plausible_web/controllers/api/stats_controller.exindex 2ab0333ef3..f587229c3d 100644--- a/lib/plausible_web/controllers/api/stats_controller.ex+++ b/lib/plausible_web/controllers/api/stats_controller.ex@@ -340,8 +340,9 @@ defmodule PlausibleWeb.Api.StatsController dosearch_term = params["search_term"] || ""with {:ok, journey} <- parse_journey(steps),+ {:ok, direction} <- parse_exploration_direction(params["direction"]),query = Query.from(site, params, debug_metadata: debug_metadata(conn)),- {:ok, next_steps} <- Exploration.next_steps(query, journey, search_term) do+ {:ok, next_steps} <- Exploration.next_steps(query, journey, search_term, direction) dojson(conn, next_steps)else_ ->@@ -353,8 +354,9 @@ defmodule PlausibleWeb.Api.StatsController dosite = conn.assigns.sitewith {:ok, journey} <- parse_journey(steps),+ {:ok, direction} <- parse_exploration_direction(params["direction"]),query = Query.from(site, params, debug_metadata: debug_metadata(conn)),- {:ok, funnel} <- Exploration.journey_funnel(query, journey) do+ {:ok, funnel} <- Exploration.journey_funnel(query, journey, direction) dojson(conn, funnel)else{:error, :empty_journey} ->@@ -382,6 +384,10 @@ defmodule PlausibleWeb.Api.StatsController do}end+ defp parse_exploration_direction("backward"), do: {:ok, :backward}+ defp parse_exploration_direction("forward"), do: {:ok, :forward}+ defp parse_exploration_direction(_), do: {:ok, :forward}+on_ee dodef funnel(conn, %{"id" => funnel_id} = params) dosite = Plausible.Repo.preload(conn.assigns.site, :team)diff --git a/test/plausible/stats/exploration_test.exs b/test/plausible/stats/exploration_test.exsindex 9f385bbc61..51d3611a46 100644--- a/test/plausible/stats/exploration_test.exs+++ b/test/plausible/stats/exploration_test.exs@@ -129,6 +129,32 @@ defmodule Plausible.Stats.ExplorationTest doassert {:error, :empty_journey} = Exploration.journey_funnel(query, [])end++ test "supports backward journey funnel", %{site: site} do+ query = QueryBuilder.build!(site, input_date_range: :all)++ journey = [+ %Exploration.Journey.Step{name: "pageview", pathname: "/logout"},+ %Exploration.Journey.Step{name: "pageview", pathname: "/login"},+ %Exploration.Journey.Step{name: "pageview", pathname: "/home"}+ ]++ assert {:ok, [step1, step2, step3]} =+ Exploration.journey_funnel(query, journey, :backward)++ assert step1.step.pathname == "/logout"+ assert step1.visitors == 1+ assert step1.dropoff == 1+ assert step1.dropoff_percentage == "50"+ assert step2.step.pathname == "/login"+ assert step2.visitors == 2+ assert step2.dropoff == 0+ assert step2.dropoff_percentage == "0"+ assert step3.step.pathname == "/home"+ assert step3.visitors == 2+ assert step3.dropoff == 0+ assert step3.dropoff_percentage == "0"+ endenddescribe "next_steps" do@@ -199,5 +225,21 @@ defmodule Plausible.Stats.ExplorationTest doassert next_step.step.pathname == "/docs"assert next_step.visitors == 1end++ test "supports backward exploration", %{site: site} do+ query = QueryBuilder.build!(site, input_date_range: :all)++ journey = [+ %Exploration.Journey.Step{name: "pageview", pathname: "/logout"}+ ]++ assert {:ok, [next_step1, next_step2]} =+ Exploration.next_steps(query, journey, "", :backward)++ assert next_step1.step.pathname == "/docs"+ assert next_step1.visitors == 1+ assert next_step2.step.pathname == "/login"+ assert next_step2.visitors == 1+ endendenddiff --git a/test/plausible_web/controllers/api/stats_controller/exploration_test.exs b/test/plausible_web/controllers/api/stats_controller/exploration_test.exsindex e2deb58d05..e3af2e5613 100644--- a/test/plausible_web/controllers/api/stats_controller/exploration_test.exs+++ b/test/plausible_web/controllers/api/stats_controller/exploration_test.exs@@ -101,6 +101,23 @@ defmodule PlausibleWeb.Api.StatsController.ExplorationTest doassert next_step["step"]["pathname"] == "/docs"assert next_step["visitors"] == 1end++ test "it supports backward direction", %{conn: conn, site: site} do+ journey = Jason.encode!([%{name: "pageview", pathname: "/logout"}])++ resp =+ conn+ |> get(+ "/api/stats/#{site.domain}/exploration/next/?journey=#{journey}&direction=backward&period=24h"+ )+ |> json_response(200)++ assert [next_step1, next_step2] = resp+ assert next_step1["step"]["pathname"] == "/docs"+ assert next_step1["visitors"] == 1+ assert next_step2["step"]["pathname"] == "/login"+ assert next_step2["visitors"] == 1+ endenddescribe "exploration_funnel/2" do@@ -132,6 +149,37 @@ defmodule PlausibleWeb.Api.StatsController.ExplorationTest doassert step3["dropoff"] == 1assert step3["dropoff_percentage"] == "50"end++ test "it supports backward direction", %{conn: conn, site: site} do+ journey =+ Jason.encode!([+ %{name: "pageview", pathname: "/logout"},+ %{name: "pageview", pathname: "/login"},+ %{name: "pageview", pathname: "/home"}+ ])++ resp =+ conn+ |> get(+ "/api/stats/#{site.domain}/exploration/funnel/?journey=#{journey}&direction=backward&period=24h"+ )+ |> json_response(200)++ assert [step1, step2, step3] = resp++ assert step1["step"]["pathname"] == "/logout"+ assert step1["visitors"] == 1+ assert step1["dropoff"] == 1+ assert step1["dropoff_percentage"] == "50"+ assert step2["step"]["pathname"] == "/login"+ assert step2["visitors"] == 2+ assert step2["dropoff"] == 0+ assert step2["dropoff_percentage"] == "0"+ assert step3["step"]["pathname"] == "/home"+ assert step3["visitors"] == 2+ assert step3["dropoff"] == 0+ assert step3["dropoff_percentage"] == "0"+ endendendend