Skip to content

Open source, privacy-first web analytics. Lightweight, cookie-free Google Analytics alternative. Self-hosted or cloud.

Recognize new sources and AI Assistants channel (ref #6422) (#6430)

Adam Rutkowskidb9bcf303763
diff --git a/lib/plausible/imported/google_analytics4.ex b/lib/plausible/imported/google_analytics4.ex
index 31a5166620..2ecb7cb40f 100644
--- a/lib/plausible/imported/google_analytics4.ex
+++ b/lib/plausible/imported/google_analytics4.ex
@@ -352,6 +352,6 @@ defmodule Plausible.Imported.GoogleAnalytics4 do
defp parse_source("duckduckgo"), do: "DuckDuckGo"
defp parse_source(ref) do
- Plausible.Ingestion.Source.parse("https://" <> ref)
+ Plausible.Ingestion.Source.from_referrer("https://" <> ref)
end
end
diff --git a/lib/plausible/ingestion/acquisition.ex b/lib/plausible/ingestion/acquisition.ex
index ef57be580a..74b8df2744 100644
--- a/lib/plausible/ingestion/acquisition.ex
+++ b/lib/plausible/ingestion/acquisition.ex
@@ -9,7 +9,8 @@ defmodule Plausible.Ingestion.Acquisition do
Notable differences from GA4 that have been implemented just for Plausible:
1. The @custom_source_categories module attribute contains a list of custom source categories that we have manually
- added based on our own judgement and user feedback. For example we treat AI tools (ChatGPT, Perplexity) as search engines.
+ added based on our own judgement and user feedback. For example we group AI assistants (ChatGPT, Claude, Gemini, etc.)
+ into their own "AI Assistants" channel.
2. Google is in a privileged position to analyze paid traffic from within their own network. The biggest use-case is auto-tagged adwords campaigns.
We do our best by categorizing as paid search when source is Google and the url has `gclid` parameter. Same for source Bing and `msclkid` url parameter.
3. The @paid_sources module attribute in Plausible.Ingestion.Source contains a list of utm_sources that we will automatically categorize as paid traffic
@@ -30,13 +31,23 @@ defmodule Plausible.Ingestion.Acquisition do
{"vkontakte", "SOURCE_CATEGORY_SOCIAL"},
{"threads", "SOURCE_CATEGORY_SOCIAL"},
{"ecosia", "SOURCE_CATEGORY_SEARCH"},
- {"perplexity", "SOURCE_CATEGORY_SEARCH"},
+ {"kagi", "SOURCE_CATEGORY_SEARCH"},
{"brave", "SOURCE_CATEGORY_SEARCH"},
- {"chatgpt.com", "SOURCE_CATEGORY_SEARCH"},
{"temu.com", "SOURCE_CATEGORY_SHOPPING"},
{"discord", "SOURCE_CATEGORY_SOCIAL"},
{"sogou", "SOURCE_CATEGORY_SEARCH"},
- {"microsoft teams", "SOURCE_CATEGORY_SOCIAL"}
+ {"microsoft teams", "SOURCE_CATEGORY_SOCIAL"},
+ {"bluesky", "SOURCE_CATEGORY_SOCIAL"},
+ {"mastodon", "SOURCE_CATEGORY_SOCIAL"},
+ {"chatgpt", "SOURCE_CATEGORY_AI_ASSISTANTS"},
+ {"claude", "SOURCE_CATEGORY_AI_ASSISTANTS"},
+ {"phind", "SOURCE_CATEGORY_AI_ASSISTANTS"},
+ {"deepseek", "SOURCE_CATEGORY_AI_ASSISTANTS"},
+ {"microsoft copilot", "SOURCE_CATEGORY_AI_ASSISTANTS"},
+ {"grok", "SOURCE_CATEGORY_AI_ASSISTANTS"},
+ {"google gemini", "SOURCE_CATEGORY_AI_ASSISTANTS"},
+ {"perplexity", "SOURCE_CATEGORY_AI_ASSISTANTS"},
+ {"x (twitter)", "SOURCE_CATEGORY_SOCIAL"}
]
@source_categories Application.app_dir(:plausible, "priv/ga4-source-categories.csv")
|> File.read!()
@@ -69,6 +80,7 @@ defmodule Plausible.Ingestion.Acquisition do
organic_shopping?(source, utm_campaign) -> "Organic Shopping"
organic_social?(source, utm_medium) -> "Organic Social"
organic_video?(source, utm_medium) -> "Organic Video"
+ ai_assistants?(source) -> "AI Assistants"
search_source?(source) -> "Organic Search"
email?(source, utm_source, utm_medium) -> "Email"
affiliates?(utm_medium) -> "Affiliates"
@@ -188,6 +200,10 @@ defmodule Plausible.Ingestion.Acquisition do
@source_categories[source] == "SOURCE_CATEGORY_EMAIL"
end
+ defp ai_assistants?(source) do
+ @source_categories[source] == "SOURCE_CATEGORY_AI_ASSISTANTS"
+ end
+
defp shopping_campaign?(utm_campaign) do
Regex.match?(~r/^(.*(([^a-df-z]|^)shop|shopping).*)$/, utm_campaign)
end
diff --git a/lib/plausible/ingestion/source.ex b/lib/plausible/ingestion/source.ex
index 207b19fc54..d80bbf2548 100644
--- a/lib/plausible/ingestion/source.ex
+++ b/lib/plausible/ingestion/source.ex
@@ -15,6 +15,11 @@ defmodule Plausible.Ingestion.Source do
|> then(&["adwords" | &1])
|> MapSet.new()
+ @custom_source_suffixes %{
+ "officeapps.live.com" => "Microsoft 365",
+ "wikipedia.org" => "Wikipedia"
+ }
+
@external_resource "priv/ref_inspector/referers.yml"
@referers_yaml Application.app_dir(:plausible, "priv/ref_inspector/referers.yml")
@@ -36,11 +41,12 @@ defmodule Plausible.Ingestion.Source do
|> Map.put(String.downcase(val), val)
end)
+ @spec from_custom_sources(String.t()) :: String.t() | nil
for {k, v} <- Enum.sort(lookup) do
- def src(unquote(k)), do: unquote(v)
+ def from_custom_sources(unquote(k)), do: unquote(v)
end
- def src(_), do: nil
+ def from_custom_sources(_), do: nil
def paid_sources() do
@paid_sources |> MapSet.to_list()
@@ -64,39 +70,60 @@ defmodule Plausible.Ingestion.Source do
perfectly, but at least we're making an effort for the most commonly used ones. For example, `ig -> Instagram` and `adwords -> Google`.
"""
def resolve(request) do
- tagged_source =
- request.query_params["utm_source"] ||
- request.query_params["source"] ||
- request.query_params["ref"]
-
- source =
- cond do
- tagged_source -> tagged_source
- has_valid_referral?(request) -> parse(request.referrer)
- true -> nil
- end
-
- find_mapping(source)
+ cond do
+ tagged = tagged_param(request) -> canonical(tagged)
+ has_valid_referral?(request) -> from_referrer(request.referrer)
+ true -> nil
+ end
end
- def parse(ref) do
- case RefInspector.parse(ref).source do
- :unknown ->
- uri = URI.parse(String.trim(ref))
- format_referrer_host(uri)
-
- source ->
- source
+ @doc """
+ Resolves a source from a bare referrer URL. This is also the entry point used
+ when importing referrers from Google Analytics, so that imported data
+ is normalized identically to live ingestion.
+ """
+ def from_referrer(referrer) do
+ host =
+ referrer
+ |> String.trim()
+ |> URI.parse()
+ |> format_referrer_host()
+
+ downcased_host = String.downcase(host)
+
+ # Prefer custom source overrides over RefInspector so subdomain matches win
+ # (e.g. gemini.google.com resolves to Google Gemini, not Google). Exact host
+ # matches take priority, then suffix families, then RefInspector.
+ cond do
+ name = from_custom_sources(downcased_host) ->
+ name
+
+ name = from_custom_source_suffix(downcased_host) ->
+ name
+
+ true ->
+ case RefInspector.parse(referrer).source do
+ :unknown -> host
+ # Normalize RefInspector names through our aliases (e.g. Twitter to X (Twitter)).
+ name -> canonical(name)
+ end
end
end
- def find_mapping(nil), do: nil
+ defp from_custom_source_suffix(host) do
+ Enum.find_value(@custom_source_suffixes, fn {suffix, name} ->
+ if host == suffix or String.ends_with?(host, "." <> suffix), do: name
+ end)
+ end
- def find_mapping(source) do
- case src(String.downcase(source)) do
- name when is_binary(name) -> name
- _ -> source
- end
+ defp tagged_param(request) do
+ request.query_params["utm_source"] ||
+ request.query_params["source"] ||
+ request.query_params["ref"]
+ end
+
+ defp canonical(source) do
+ from_custom_sources(String.downcase(source)) || source
end
def format_referrer(request) do
diff --git a/lib/plausible_web/plugs/favicon.ex b/lib/plausible_web/plugs/favicon.ex
index 89a25fda57..4f9c4f2aae 100644
--- a/lib/plausible_web/plugs/favicon.ex
+++ b/lib/plausible_web/plugs/favicon.ex
@@ -34,12 +34,25 @@ defmodule PlausibleWeb.Favicon do
@external_resource @placeholder_icon_location
@custom_icons %{
"Brave" => "search.brave.com",
+ "Kagi" => "kagi.com",
"Sogou" => "sogou.com",
"Wikipedia" => "en.wikipedia.org",
"Discord" => "discord.com",
"Perplexity" => "perplexity.ai",
"Microsoft Teams" => "microsoft.com",
- "LinkedIn" => "linkedin.com"
+ "LinkedIn" => "linkedin.com",
+ "Linktree" => "linktr.ee",
+ "Bluesky" => "bsky.app",
+ "Mastodon" => "mastodon.social",
+ "Google Gemini" => "gemini.google.com",
+ "ChatGPT" => "chatgpt.com",
+ "Claude" => "claude.ai",
+ "Phind" => "phind.com",
+ "DeepSeek" => "deepseek.com",
+ "Microsoft Copilot" => "copilot.com",
+ "Grok" => "grok.com",
+ "X (Twitter)" => "x.com",
+ "Microsoft 365" => "office.com"
}
def init(_) do
diff --git a/priv/custom_sources.json b/priv/custom_sources.json
index bf635e26c2..c73c7a9dc3 100644
--- a/priv/custom_sources.json
+++ b/priv/custom_sources.json
@@ -1,12 +1,44 @@
{
+ "bsky.app":"Bluesky",
+ "go.bsky.app":"Bluesky",
"android-app://com.reddit.frontpage":"Reddit",
"baidu.com":"Baidu",
+ "chatgpt.com":"ChatGPT",
+ "chat.openai.com":"ChatGPT",
+ "claude.ai":"Claude",
+ "copilot.microsoft.com":"Microsoft Copilot",
+ "copilot.com":"Microsoft Copilot",
+ "copilot":"Microsoft Copilot",
+ "deepseek.com":"DeepSeek",
+ "gemini.google.com":"Google Gemini",
+ "grok.com":"Grok",
+ "x.ai":"Grok",
+ "phind.com":"Phind",
+ "chaos.social":"Mastodon",
+ "fosstodon.org":"Mastodon",
+ "hachyderm.io":"Mastodon",
+ "indieweb.social":"Mastodon",
+ "infosec.exchange":"Mastodon",
+ "mas.to":"Mastodon",
+ "mastodon.online":"Mastodon",
+ "mastodon.social":"Mastodon",
+ "mastodon.world":"Mastodon",
+ "mathstodon.xyz":"Mastodon",
+ "mstdn.jp":"Mastodon",
+ "mstdn.social":"Mastodon",
+ "scholar.social":"Mastodon",
+ "sigmoid.social":"Mastodon",
+ "social.tchncs.de":"Mastodon",
+ "android-app://org.joinmastodon.android": "Mastodon",
"discord.com":"Discord",
"discordapp.com":"Discord",
"linktr.ee":"Linktree",
"m.sogou.com":"Sogou",
+ "kagi.com":"Kagi",
+ "l.threads.com":"Threads",
"ntp.msn.com":"Bing",
"perplexity.ai":"Perplexity",
+ "pplx.ai":"Perplexity",
"ptb.discord.com":"Discord",
"search.brave.com":"Brave",
"sogou.com":"Sogou",
@@ -40,177 +72,13 @@
"gads": "Google",
"google ads": "Google",
"adwords": "Google",
- "twitter-ads": "Twitter",
+ "x.com":"X (Twitter)",
+ "mobile.twitter.com": "X (Twitter)",
+ "twitter-ads": "X (Twitter)",
+ "twitter": "X (Twitter)",
"tiktokads": "TikTok",
"tik.tok": "TikTok",
- "perplexity": "Perplexity",
- "linktree": "Linktree",
- "fo.wikipedia.org":"Wikipedia",
- "ga.wikipedia.org":"Wikipedia",
- "el.m.wikipedia.org":"Wikipedia",
- "eo.m.wikipedia.org":"Wikipedia",
- "ms.m.wikipedia.org":"Wikipedia",
- "nl.wikipedia.org":"Wikipedia",
- "dga.m.wikipedia.org":"Wikipedia",
- "th.wikipedia.org":"Wikipedia",
- "oc.wikipedia.org":"Wikipedia",
- "da.wikipedia.org":"Wikipedia",
- "pt.m.wikipedia.org":"Wikipedia",
- "szl.m.wikipedia.org":"Wikipedia",
- "be-tarask.wikipedia.org":"Wikipedia",
- "ta.m.wikipedia.org":"Wikipedia",
- "pa.m.wikipedia.org":"Wikipedia",
- "mn.wikipedia.org":"Wikipedia",
- "sv.m.wikipedia.org":"Wikipedia",
- "sk.wikipedia.org":"Wikipedia",
- "it.wikipedia.org":"Wikipedia",
- "el.wikipedia.org":"Wikipedia",
- "olo.wikipedia.org":"Wikipedia",
- "hi.m.wikipedia.org":"Wikipedia",
- "bn.m.wikipedia.org":"Wikipedia",
- "uz.wikipedia.org":"Wikipedia",
- "fr.m.wikipedia.org":"Wikipedia",
- "fa.wikipedia.org":"Wikipedia",
- "fi.wikipedia.org":"Wikipedia",
- "arz.m.wikipedia.org":"Wikipedia",
- "si.m.wikipedia.org":"Wikipedia",
- "bjn.wikipedia.org":"Wikipedia",
- "kn.wikipedia.org":"Wikipedia",
- "is.m.wikipedia.org":"Wikipedia",
- "nostalgia.wikipedia.org":"Wikipedia",
- "en.wikipedia.org":"Wikipedia",
- "nl.m.wikipedia.org":"Wikipedia",
- "nn.m.wikipedia.org":"Wikipedia",
- "bs.wikipedia.org":"Wikipedia",
- "sh.m.wikipedia.org":"Wikipedia",
- "vi.m.wikipedia.org":"Wikipedia",
- "ru.wikipedia.org":"Wikipedia",
- "tr.m.wikipedia.org":"Wikipedia",
- "he.wikipedia.org":"Wikipedia",
- "ta.wikipedia.org":"Wikipedia",
- "es.wikipedia.org":"Wikipedia",
- "si.wikipedia.org":"Wikipedia",
- "pl.wikipedia.org":"Wikipedia",
- "hu.wikipedia.org":"Wikipedia",
- "lij.m.wikipedia.org":"Wikipedia",
- "nn.wikipedia.org":"Wikipedia",
- "ko.m.wikipedia.org":"Wikipedia",
- "da.m.wikipedia.org":"Wikipedia",
- "zh.m.wikipedia.org":"Wikipedia",
- "vec.wikipedia.org":"Wikipedia",
- "ar.wikipedia.org":"Wikipedia",
- "bcl.m.wikipedia.org":"Wikipedia",
- "en.m.wikipedia.org":"Wikipedia",
- "sw.wikipedia.org":"Wikipedia",
- "la.m.wikipedia.org":"Wikipedia",
- "ur.m.wikipedia.org":"Wikipedia",
- "id.m.wikipedia.org":"Wikipedia",
- "crh.wikipedia.org":"Wikipedia",
- "sr.wikipedia.org":"Wikipedia",
- "sw.m.wikipedia.org":"Wikipedia",
- "ka.m.wikipedia.org":"Wikipedia",
- "lt.m.wikipedia.org":"Wikipedia",
- "fy.wikipedia.org":"Wikipedia",
- "ro.m.wikipedia.org":"Wikipedia",
- "hr.wikipedia.org":"Wikipedia",
- "mn.m.wikipedia.org":"Wikipedia",
- "pt.wikipedia.org":"Wikipedia",
- "it.m.wikipedia.org":"Wikipedia",
- "lv.m.wikipedia.org":"Wikipedia",
- "fa.m.wikipedia.org":"Wikipedia",
- "ja.wikipedia.org":"Wikipedia",
- "lv.wikipedia.org":"Wikipedia",
- "hu.m.wikipedia.org":"Wikipedia",
- "de.wikipedia.org":"Wikipedia",
- "uk.wikipedia.org":"Wikipedia",
- "ml.wikipedia.org":"Wikipedia",
- "te.m.wikipedia.org":"Wikipedia",
- "bg.wikipedia.org":"Wikipedia",
- "eu.wikipedia.org":"Wikipedia",
- "arz.wikipedia.org":"Wikipedia",
- "id.wikipedia.org":"Wikipedia",
- "mg.m.wikipedia.org":"Wikipedia",
- "sq.m.wikipedia.org":"Wikipedia",
- "ca.wikipedia.org":"Wikipedia",
- "sk.m.wikipedia.org":"Wikipedia",
- "az.wikipedia.org":"Wikipedia",
- "ru.m.wikipedia.org":"Wikipedia",
- "uz.m.wikipedia.org":"Wikipedia",
- "wuu.wikipedia.org":"Wikipedia",
- "hy.wikipedia.org":"Wikipedia",
- "la.wikipedia.org":"Wikipedia",
- "ca.m.wikipedia.org":"Wikipedia",
- "ckb.m.wikipedia.org":"Wikipedia",
- "tt.wikipedia.org":"Wikipedia",
- "gu.m.wikipedia.org":"Wikipedia",
- "lrc.wikipedia.org":"Wikipedia",
- "be-tarask.m.wikipedia.org":"Wikipedia",
- "no.m.wikipedia.org":"Wikipedia",
- "simple.m.wikipedia.org":"Wikipedia",
- "eu.m.wikipedia.org":"Wikipedia",
- "ne.m.wikipedia.org":"Wikipedia",
- "sr.m.wikipedia.org":"Wikipedia",
- "vi.wikipedia.org":"Wikipedia",
- "lt.wikipedia.org":"Wikipedia",
- "cs.m.wikipedia.org":"Wikipedia",
- "hy.m.wikipedia.org":"Wikipedia",
- "mr.wikipedia.org":"Wikipedia",
- "sv.wikipedia.org":"Wikipedia",
- "eo.wikipedia.org":"Wikipedia",
- "as.m.wikipedia.org":"Wikipedia",
- "is.wikipedia.org":"Wikipedia",
- "sh.wikipedia.org":"Wikipedia",
- "zh-classical.wikipedia.org":"Wikipedia",
- "nds-nl.m.wikipedia.org":"Wikipedia",
- "tl.m.wikipedia.org":"Wikipedia",
- "tr.wikipedia.org":"Wikipedia",
- "cs.wikipedia.org":"Wikipedia",
- "uk.m.wikipedia.org":"Wikipedia",
- "sq.wikipedia.org":"Wikipedia",
- "et.m.wikipedia.org":"Wikipedia",
- "hr.m.wikipedia.org":"Wikipedia",
- "bn.wikipedia.org":"Wikipedia",
- "sl.wikipedia.org":"Wikipedia",
- "th.m.wikipedia.org":"Wikipedia",
- "hi.wikipedia.org":"Wikipedia",
- "he.m.wikipedia.org":"Wikipedia",
- "bat-smg.wikipedia.org":"Wikipedia",
- "ml.m.wikipedia.org":"Wikipedia",
- "zh.wikipedia.org":"Wikipedia",
- "fi.m.wikipedia.org":"Wikipedia",
- "de.m.wikipedia.org":"Wikipedia",
- "be.wikipedia.org":"Wikipedia",
- "pl.m.wikipedia.org":"Wikipedia",
- "simple.wikipedia.org":"Wikipedia",
- "rw.m.wikipedia.org":"Wikipedia",
- "no.wikipedia.org":"Wikipedia",
- "ja.m.wikipedia.org":"Wikipedia",
- "yi.m.wikipedia.org":"Wikipedia",
- "ga.m.wikipedia.org":"Wikipedia",
- "ar.m.wikipedia.org":"Wikipedia",
+ "wikipedia": "Wikipedia",
"canary.discord.com":"Discord",
- "sa.m.wikipedia.org":"Wikipedia",
- "ky.wikipedia.org":"Wikipedia",
- "es.m.wikipedia.org":"Wikipedia",
- "new.wikipedia.org":"Wikipedia",
- "lij.wikipedia.org":"Wikipedia",
- "zh-yue.wikipedia.org":"Wikipedia",
- "bg.m.wikipedia.org":"Wikipedia",
- "bs.m.wikipedia.org":"Wikipedia",
- "dz.wikipedia.org":"Wikipedia",
- "kk.m.wikipedia.org":"Wikipedia",
- "fr.wikipedia.org":"Wikipedia",
- "qu.wikipedia.org":"Wikipedia",
- "ka.wikipedia.org":"Wikipedia",
- "webk.telegram.org":"Telegram",
- "et.wikipedia.org":"Wikipedia",
- "ms.wikipedia.org":"Wikipedia",
- "az.m.wikipedia.org":"Wikipedia",
- "cy.wikipedia.org":"Wikipedia",
- "ro.wikipedia.org":"Wikipedia",
- "mk.wikipedia.org":"Wikipedia",
- "tl.wikipedia.org":"Wikipedia",
- "am.wikipedia.org":"Wikipedia",
- "ko.wikipedia.org":"Wikipedia",
- "sl.m.wikipedia.org":"Wikipedia"
+ "webk.telegram.org":"Telegram"
}
diff --git a/priv/data_migrations/AcquisitionChannel/sql/acquisition_channel_functions.sql.eex b/priv/data_migrations/AcquisitionChannel/sql/acquisition_channel_functions.sql.eex
index 7287f7f57f..4de5145210 100644
--- a/priv/data_migrations/AcquisitionChannel/sql/acquisition_channel_functions.sql.eex
+++ b/priv/data_migrations/AcquisitionChannel/sql/acquisition_channel_functions.sql.eex
@@ -81,6 +81,10 @@ CREATE OR REPLACE FUNCTION acquisition_channel_has_category_email <%= @on_cluste
(referrer_source) ->
dictGet('acquisition_channel_source_category_dict', 'category', referrer_source) = 'SOURCE_CATEGORY_EMAIL';
+CREATE OR REPLACE FUNCTION acquisition_channel_has_category_ai_assistants <%= @on_cluster_statement %> AS
+(referrer_source) ->
+ dictGet('acquisition_channel_source_category_dict', 'category', referrer_source) = 'SOURCE_CATEGORY_AI_ASSISTANTS';
+
CREATE OR REPLACE FUNCTION acquisition_channel_paid_utm_source <%= @on_cluster_statement %> AS
(referrer_source) ->
dictHas('acquisition_channel_paid_sources_dict', referrer_source);
@@ -218,6 +222,7 @@ CREATE OR REPLACE FUNCTION acquisition_channel_lowered <%= @on_cluster_statement
acquisition_channel_organic_shopping(referrer_source, utm_campaign), 'Organic Shopping',
acquisition_channel_organic_social(referrer_source, utm_medium), 'Organic Social',
acquisition_channel_organic_video(referrer_source, utm_medium), 'Organic Video',
+ acquisition_channel_has_category_ai_assistants(referrer_source), 'AI Assistants',
acquisition_channel_has_category_search(referrer_source), 'Organic Search',
acquisition_channel_email(referrer_source, utm_source, utm_medium), 'Email',
acquisition_channel_affiliates(utm_medium), 'Affiliates',
diff --git a/test/plausible/ingestion/acquisition_test.exs b/test/plausible/ingestion/acquisition_test.exs
index 68d95a69cd..2dc78efb75 100644
--- a/test/plausible/ingestion/acquisition_test.exs
+++ b/test/plausible/ingestion/acquisition_test.exs
@@ -47,7 +47,7 @@ defmodule Plausible.Ingestion.AcquisitionTest do
%{referrer_source: "walmart", utm_source: "walmart", expected: "Organic Shopping"},
%{utm_campaign: "shop", expected: "Organic Shopping"},
%{referrer_source: "Facebook", expected: "Organic Social"},
- %{referrer_source: "twitter", utm_source: "twitter", expected: "Organic Social"},
+ %{referrer_source: "X (Twitter)", utm_source: "twitter", expected: "Organic Social"},
%{utm_medium: "social", expected: "Organic Social"},
%{referrer_source: "Vimeo", expected: "Organic Video"},
%{referrer_source: "vimeo", utm_source: "vimeo", expected: "Organic Video"},
@@ -76,9 +76,9 @@ defmodule Plausible.Ingestion.AcquisitionTest do
%{referrer_source: "Google", utm_source: "google_ads", expected: "Paid Search"},
%{referrer_source: "Google", utm_source: "Google-ads", expected: "Paid Search"},
%{referrer_source: "Google", utm_source: "Adwords", expected: "Paid Search"},
- %{referrer_source: "Twitter", utm_source: "twitter-ads", expected: "Paid Social"},
+ %{referrer_source: "X (Twitter)", utm_source: "twitter-ads", expected: "Paid Social"},
%{referrer_source: "Reddit", expected: "Organic Social"},
- %{referrer_source: "Perplexity", expected: "Organic Search"},
+ %{referrer_source: "Perplexity", expected: "AI Assistants"},
%{referrer_source: "Microsoft Teams", expected: "Organic Social"},
%{referrer_source: "Wikipedia", expected: "Referral"},
%{referrer_source: "Bing", expected: "Organic Search"},
@@ -96,7 +96,15 @@ defmodule Plausible.Ingestion.AcquisitionTest do
%{referrer_source: "Newsletter-UK", utm_source: "Newsletter-UK", expected: "Email"},
%{referrer_source: "temu.com", expected: "Organic Shopping"},
%{referrer_source: "Telegram", utm_source: "Telegram", expected: "Organic Social"},
- %{referrer_source: "chatgpt.com", expected: "Organic Search"},
+ %{referrer_source: "Bluesky", expected: "Organic Social"},
+ %{referrer_source: "Mastodon", expected: "Organic Social"},
+ %{referrer_source: "Google Gemini", expected: "AI Assistants"},
+ %{referrer_source: "ChatGPT", expected: "AI Assistants"},
+ %{referrer_source: "Claude", expected: "AI Assistants"},
+ %{referrer_source: "Phind", expected: "AI Assistants"},
+ %{referrer_source: "DeepSeek", expected: "AI Assistants"},
+ %{referrer_source: "Microsoft Copilot", expected: "AI Assistants"},
+ %{referrer_source: "Grok", expected: "AI Assistants"},
%{referrer_source: "Slack", expected: "Organic Social"},
%{referrer_source: "producthunt", expected: "Organic Social"},
%{referrer_source: "GitHub", expected: "Organic Social"},
@@ -104,6 +112,8 @@ defmodule Plausible.Ingestion.AcquisitionTest do
%{referrer_source: "Vkontakte", expected: "Organic Social"},
%{referrer_source: "Threads", expected: "Organic Social"},
%{referrer_source: "Ecosia", expected: "Organic Search"},
+ %{referrer_source: "Kagi", expected: "Organic Search"},
+ %{referrer_source: "Microsoft 365", expected: "Referral"},
%{
referrer_source: "Google",
utm_medium: "display",
diff --git a/test/plausible/ingestion/source_test.exs b/test/plausible/ingestion/source_test.exs
index b3d02867be..d136def1dc 100644
--- a/test/plausible/ingestion/source_test.exs
+++ b/test/plausible/ingestion/source_test.exs
@@ -36,4 +36,114 @@ defmodule Plausible.Ingestion.SourceTest do
assert Source.resolve(%{@base_request | referrer: "https://www.markosaric.com"}) ==
"markosaric.com"
end
+
+ test "bsky.app referrer is Bluesky" do
+ assert Source.resolve(%{@base_request | referrer: "https://bsky.app"}) == "Bluesky"
+ end
+
+ test "go.bsky.app referrer is Bluesky" do
+ assert Source.resolve(%{@base_request | referrer: "https://go.bsky.app"}) == "Bluesky"
+ end
+
+ test "mastodon.social referrer is Mastodon" do
+ assert Source.resolve(%{@base_request | referrer: "https://mastodon.social"}) == "Mastodon"
+ end
+
+ test "fosstodon.org referrer is Mastodon" do
+ assert Source.resolve(%{@base_request | referrer: "https://fosstodon.org"}) == "Mastodon"
+ end
+
+ test "gemini.google.com referrer is Google Gemini, not Google" do
+ assert Source.resolve(%{@base_request | referrer: "https://gemini.google.com"}) ==
+ "Google Gemini"
+ end
+
+ test "chatgpt.com referrer is ChatGPT" do
+ assert Source.resolve(%{@base_request | referrer: "https://chatgpt.com"}) == "ChatGPT"
+ end
+
+ test "chat.openai.com referrer is ChatGPT" do
+ assert Source.resolve(%{@base_request | referrer: "https://chat.openai.com"}) == "ChatGPT"
+ end
+
+ test "claude.ai referrer is Claude" do
+ assert Source.resolve(%{@base_request | referrer: "https://claude.ai"}) == "Claude"
+ end
+
+ test "phind.com referrer is Phind" do
+ assert Source.resolve(%{@base_request | referrer: "https://phind.com"}) == "Phind"
+ end
+
+ test "copilot.microsoft.com referrer is Microsoft Copilot" do
+ assert Source.resolve(%{@base_request | referrer: "https://copilot.microsoft.com"}) ==
+ "Microsoft Copilot"
+ end
+
+ test "copilot.com referrer is Microsoft Copilot" do
+ assert Source.resolve(%{@base_request | referrer: "https://copilot.com"}) ==
+ "Microsoft Copilot"
+ end
+
+ test "x.com referrer is X (Twitter)" do
+ assert Source.resolve(%{@base_request | referrer: "https://x.com"}) == "X (Twitter)"
+ end
+
+ test "kagi.com referrer is Kagi" do
+ assert Source.resolve(%{@base_request | referrer: "https://kagi.com"}) == "Kagi"
+ end
+
+ test "l.threads.com referrer is Threads" do
+ assert Source.resolve(%{@base_request | referrer: "https://l.threads.com"}) == "Threads"
+ end
+
+ test "pplx.ai referrer is Perplexity" do
+ assert Source.resolve(%{@base_request | referrer: "https://pplx.ai"}) == "Perplexity"
+ end
+
+ test "officeapps.live.com and its subdomains are Microsoft 365" do
+ for referrer <- [
+ "https://officeapps.live.com",
+ "https://cac-excel.officeapps.live.com",
+ "https://euc-excel.officeapps.live.com",
+ "https://ukc-word-edit.officeapps.live.com"
+ ] do
+ assert Source.resolve(%{@base_request | referrer: referrer}) == "Microsoft 365"
+ end
+ end
+
+ test "a host that only looks like the officeapps suffix is not Microsoft 365" do
+ assert Source.resolve(%{@base_request | referrer: "https://notofficeapps.live.com"}) ==
+ "notofficeapps.live.com"
+ end
+
+ test "any wikipedia.org subdomain is Wikipedia (including unlisted language editions)" do
+ for referrer <- [
+ "https://wikipedia.org",
+ "https://www.wikipedia.org",
+ "https://en.wikipedia.org",
+ "https://en.m.wikipedia.org",
+ "https://zu.wikipedia.org"
+ ] do
+ assert Source.resolve(%{@base_request | referrer: referrer}) == "Wikipedia"
+ end
+ end
+
+ test "a host that only looks like the wikipedia suffix is not Wikipedia" do
+ assert Source.resolve(%{@base_request | referrer: "https://notwikipedia.org"}) ==
+ "notwikipedia.org"
+ end
+
+ test "RefInspector-resolved aliases are normalized (t.co referrer is 'X (Twitter)')" do
+ # t.co is a Twitter domain known to RefInspector but not in custom_sources.json,
+ # so it exercises the RefInspector branch and canonical mapping ('Twitter' to 'X (Twitter)').
+ assert Source.resolve(%{@base_request | referrer: "https://t.co"}) == "X (Twitter)"
+ end
+
+ test "from_referrer normalizes RefInspector aliases like resolve does" do
+ # The importer calls from_referrer directly, so it must apply the same aliasing
+ # as live ingestion (previously it returned the raw "Twitter").
+ assert Source.from_referrer("https://t.co") == "X (Twitter)"
+ assert Source.from_referrer("https://gemini.google.com") == "Google Gemini"
+ assert Source.from_referrer("https://www.markosaric.com") == "markosaric.com"
+ end
end
diff --git a/test/plausible_web/controllers/api/external_controller_test.exs b/test/plausible_web/controllers/api/external_controller_test.exs
index f25f5529bb..d5726c5d15 100644
--- a/test/plausible_web/controllers/api/external_controller_test.exs
+++ b/test/plausible_web/controllers/api/external_controller_test.exs
@@ -1499,1864 +1499,710 @@ defmodule PlausibleWeb.Api.ExternalControllerTest do
{:ok, site: site}
end
- test "parses cross network channel", %{conn: conn, site: site} do
- params = %{
- name: "pageview",
- url: "http://example.com/?utm_campaign=cross-network",
- domain: site.domain
- }
+ test "parses cross network channel", %{site: site} do
+ site
+ |> submit_event(%{url: "http://example.com/?utm_campaign=cross-network"})
+ |> assert_acquisition_channel("Cross-network")
+ end
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
+ test "parses paid shopping channel based on campaign/medium", %{site: site} do
+ site
+ |> submit_event(%{url: "http://example.com/?utm_campaign=shopping&utm_medium=paid"})
+ |> assert_acquisition_channel("Paid Shopping")
+ end
- [session] = get_sessions(site)
+ test "parses paid shopping channel based on referrer source and medium", %{site: site} do
+ site
+ |> submit_event(%{
+ url: "http://example.com?utm_medium=paid",
+ referrer: "https://shopify.com"
+ })
+ |> assert_acquisition_channel("Paid Shopping")
+ end
- assert response(conn, 202) == "ok"
- assert session.acquisition_channel == "Cross-network"
+ test "parses paid shopping channel based on referrer utm_source and medium", %{site: site} do
+ site
+ |> submit_event(%{url: "http://example.com?utm_source=shopify&utm_medium=paid"})
+ |> assert_acquisition_channel("Paid Shopping")
end
- test "parses paid shopping channel based on campaign/medium", %{conn: conn, site: site} do
- params = %{
- name: "pageview",
- url: "http://example.com/?utm_campaign=shopping&utm_medium=paid",
- domain: site.domain
- }
+ test "parses paid search channel based on referrer and medium", %{site: site} do
+ site
+ |> submit_event(%{
+ url: "http://example.com?utm_medium=paid",
+ referrer: "https://duckduckgo.com"
+ })
+ |> assert_acquisition_channel("Paid Search")
+ end
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
+ test "parses paid search channel based on gclid", %{site: site} do
+ site
+ |> submit_event(%{
+ url: "http://example.com?gclid=123identifier",
+ referrer: "https://google.com"
+ })
+ |> assert_acquisition_channel("Paid Search")
+ |> assert_utm_medium("(gclid)")
+ |> assert_click_id_param("gclid")
+ end
- [session] = get_sessions(site)
+ test "is not paid search when gclid is present on non-google referrer", %{site: site} do
+ site
+ |> submit_event(%{
+ url: "http://example.com?gclid=123identifier",
+ referrer: "https://duckduckgo.com"
+ })
+ |> assert_acquisition_channel("Organic Search")
+ |> assert_utm_medium("")
+ |> assert_click_id_param("gclid")
+ end
- assert response(conn, 202) == "ok"
- assert session.acquisition_channel == "Paid Shopping"
+ test "does not override utm_medium with (gclid) if link is already tagged", %{site: site} do
+ site
+ |> submit_event(%{
+ url: "http://example.com?gclid=123identifier&utm_medium=paidads",
+ referrer: "https://google.com"
+ })
+ |> assert_acquisition_channel("Paid Search")
+ |> assert_utm_medium("paidads")
+ |> assert_click_id_param("gclid")
end
- test "parses paid shopping channel based on referrer source and medium", %{
- conn: conn,
- site: site
- } do
- params = %{
- name: "pageview",
- url: "http://example.com?utm_medium=paid",
- referrer: "https://shopify.com",
- domain: site.domain
- }
+ test "parses paid search channel based on msclkid", %{site: site} do
+ site
+ |> submit_event(%{
+ url: "http://example.com?msclkid=123identifier",
+ referrer: "https://bing.com"
+ })
+ |> assert_acquisition_channel("Paid Search")
+ |> assert_utm_medium("(msclkid)")
+ |> assert_click_id_param("msclkid")
+ end
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
+ test "is not paid search when msclkid is present on non-bing referrer", %{site: site} do
+ site
+ |> submit_event(%{
+ url: "http://example.com?msclkid=123identifier&utm_medium=cpc",
+ referrer: "https://bing.com"
+ })
+ |> assert_acquisition_channel("Paid Search")
+ |> assert_utm_medium("cpc")
+ |> assert_click_id_param("msclkid")
+ end
- [session] = get_sessions(site)
+ test "does not override utm_medium with (msclkid) if link is already tagged", %{site: site} do
+ site
+ |> submit_event(%{
+ url: "http://example.com?gclid=123identifier&utm_medium=paidads",
+ referrer: "https://google.com"
+ })
+ |> assert_acquisition_channel("Paid Search")
+ |> assert_utm_medium("paidads")
+ |> assert_click_id_param("gclid")
+ end
- assert response(conn, 202) == "ok"
- assert session.acquisition_channel == "Paid Shopping"
+ test "parses paid search channel based on utm_source and medium", %{site: site} do
+ site
+ |> submit_event(%{url: "http://example.com?utm_source=google&utm_medium=paid"})
+ |> assert_acquisition_channel("Paid Search")
+ |> assert_click_id_param("")
end
- test "parses paid shopping channel based on referrer utm_source and medium", %{
- conn: conn,
- site: site
- } do
- params = %{
- name: "pageview",
- url: "http://example.com?utm_source=shopify&utm_medium=paid",
- domain: site.domain
- }
+ test "parses paid social channel based on referrer and medium", %{site: site} do
+ site
+ |> submit_event(%{
+ url: "http://example.com?utm_medium=paid",
+ referrer: "https://tiktok.com"
+ })
+ |> assert_acquisition_channel("Paid Social")
+ end
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
+ test "parses paid social channel based on utm_source and medium", %{site: site} do
+ site
+ |> submit_event(%{url: "http://example.com?utm_source=tiktok&utm_medium=paid"})
+ |> assert_acquisition_channel("Paid Social")
+ end
- [session] = get_sessions(site)
+ test "parses paid video channel based on referrer and medium", %{site: site} do
+ site
+ |> submit_event(%{
+ url: "http://example.com?utm_medium=paid",
+ referrer: "https://youtube.com"
+ })
+ |> assert_acquisition_channel("Paid Video")
+ end
- assert response(conn, 202) == "ok"
- assert session.acquisition_channel == "Paid Shopping"
+ test "parses paid video channel based on utm_source and medium", %{site: site} do
+ site
+ |> submit_event(%{url: "http://example.com?utm_source=youtube&utm_medium=paid"})
+ |> assert_acquisition_channel("Paid Video")
end
- test "parses paid search channel based on referrer and medium", %{conn: conn, site: site} do
- params = %{
- name: "pageview",
- url: "http://example.com?utm_medium=paid",
- referrer: "https://duckduckgo.com",
- domain: site.domain
- }
+ test "parses display channel", %{site: site} do
+ site
+ |> submit_event(%{url: "http://example.com?utm_medium=banner"})
+ |> assert_acquisition_channel("Display")
+ end
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
+ test "display channel with gclid", %{site: site} do
+ site
+ |> submit_event(%{
+ url: "http://example.com?utm_medium=display&utm_source=google&gclid=123identifier"
+ })
+ |> assert_acquisition_channel("Display")
+ end
- [session] = get_sessions(site)
+ test "parses paid other channel", %{site: site} do
+ site
+ |> submit_event(%{url: "http://example.com?utm_medium=cpc"})
+ |> assert_acquisition_channel("Paid Other")
+ end
- assert response(conn, 202) == "ok"
- assert session.acquisition_channel == "Paid Search"
+ test "parses organic shopping channel from referrer", %{site: site} do
+ site
+ |> submit_event(%{url: "http://example.com", referrer: "https://walmart.com"})
+ |> assert_acquisition_channel("Organic Shopping")
end
- test "parses paid search channel based on gclid", %{conn: conn, site: site} do
- params = %{
- name: "pageview",
- url: "http://example.com?gclid=123identifier",
- referrer: "https://google.com",
- domain: site.domain
- }
+ test "parses organic shopping channel from utm_source", %{site: site} do
+ site
+ |> submit_event(%{url: "http://example.com?utm_source=walmart"})
+ |> assert_acquisition_channel("Organic Shopping")
+ end
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
+ test "parses organic shopping channel from utm_campaign", %{site: site} do
+ site
+ |> submit_event(%{url: "http://example.com?utm_campaign=shop"})
+ |> assert_acquisition_channel("Organic Shopping")
+ end
- [session] = get_sessions(site)
+ test "parses organic social channel from referrer", %{site: site} do
+ site
+ |> submit_event(%{url: "http://example.com", referrer: "http://facebook.com"})
+ |> assert_acquisition_channel("Organic Social")
+ end
- assert response(conn, 202) == "ok"
- assert session.acquisition_channel == "Paid Search"
- assert session.utm_medium == "(gclid)"
- assert session.click_id_param == "gclid"
+ test "parses organic social channel from utm_source", %{site: site} do
+ site
+ |> submit_event(%{url: "http://example.com?utm_source=twitter"})
+ |> assert_acquisition_channel("Organic Social")
end
- test "is not paid search when gclid is present on non-google referrer", %{
- conn: conn,
- site: site
- } do
- params = %{
- name: "pageview",
- url: "http://example.com?gclid=123identifier",
- referrer: "https://duckduckgo.com",
- domain: site.domain
- }
+ test "parses organic social channel from utm_medium", %{site: site} do
+ site
+ |> submit_event(%{url: "http://example.com?utm_medium=social"})
+ |> assert_acquisition_channel("Organic Social")
+ end
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
+ test "parses organic video channel from referrer", %{site: site} do
+ site
+ |> submit_event(%{url: "http://example.com", referrer: "https://vimeo.com"})
+ |> assert_acquisition_channel("Organic Video")
+ end
- [session] = get_sessions(site)
+ test "parses organic video channel from utm_source", %{site: site} do
+ site
+ |> submit_event(%{url: "http://example.com?utm_source=vimeo"})
+ |> assert_acquisition_channel("Organic Video")
+ end
- assert response(conn, 202) == "ok"
- assert session.acquisition_channel == "Organic Search"
- assert session.utm_medium == ""
- assert session.click_id_param == "gclid"
+ test "parses organic video channel from utm_medium", %{site: site} do
+ site
+ |> submit_event(%{url: "http://example.com?utm_medium=video"})
+ |> assert_acquisition_channel("Organic Video")
end
- test "does not override utm_medium with (gclid) if link is already tagged", %{
- conn: conn,
- site: site
- } do
- params = %{
- name: "pageview",
- url: "http://example.com?gclid=123identifier&utm_medium=paidads",
- referrer: "https://google.com",
- domain: site.domain
- }
+ test "parses organic search channel from referrer", %{site: site} do
+ site
+ |> submit_event(%{url: "http://example.com", referrer: "http://duckduckgo.com"})
+ |> assert_acquisition_channel("Organic Search")
+ end
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
+ test "parses organic search channel from utm_source", %{site: site} do
+ site
+ |> submit_event(%{url: "http://example.com?utm_source=duckduckgo"})
+ |> assert_acquisition_channel("Organic Search")
+ end
- [session] = get_sessions(site)
+ test "parses referral channel from utm_medium", %{site: site} do
+ site
+ |> submit_event(%{url: "http://example.com?utm_medium=referral"})
+ |> assert_acquisition_channel("Referral")
+ end
- assert response(conn, 202) == "ok"
- assert session.acquisition_channel == "Paid Search"
- assert session.utm_medium == "paidads"
- assert session.click_id_param == "gclid"
+ test "parses email channel from utm_source", %{site: site} do
+ site
+ |> submit_event(%{url: "http://example.com?utm_source=email"})
+ |> assert_acquisition_channel("Email")
end
- test "parses paid search channel based on msclkid", %{conn: conn, site: site} do
- params = %{
- name: "pageview",
- url: "http://example.com?msclkid=123identifier",
- referrer: "https://bing.com",
- domain: site.domain
- }
+ test "parses email channel from utm_medium", %{site: site} do
+ site
+ |> submit_event(%{url: "http://example.com?utm_medium=email"})
+ |> assert_acquisition_channel("Email")
+ end
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
+ test "parses affiliates channel from utm_medium", %{site: site} do
+ site
+ |> submit_event(%{url: "http://example.com?utm_medium=affiliate"})
+ |> assert_acquisition_channel("Affiliates")
+ end
- [session] = get_sessions(site)
+ test "parses audio channel from utm_medium", %{site: site} do
+ site
+ |> submit_event(%{url: "http://example.com?utm_medium=audio"})
+ |> assert_acquisition_channel("Audio")
+ end
- assert response(conn, 202) == "ok"
- assert session.acquisition_channel == "Paid Search"
- assert session.utm_medium == "(msclkid)"
- assert session.click_id_param == "msclkid"
+ test "parses sms channel from utm_source", %{site: site} do
+ site
+ |> submit_event(%{url: "http://example.com?utm_source=sms"})
+ |> assert_acquisition_channel("SMS")
end
- test "is not paid search when msclkid is present on non-bing referrer", %{
- conn: conn,
- site: site
- } do
- params = %{
- name: "pageview",
- url: "http://example.com?msclkid=123identifier&utm_medium=cpc",
- referrer: "https://bing.com",
- domain: site.domain
- }
+ test "parses sms channel from utm_medium", %{site: site} do
+ site
+ |> submit_event(%{url: "http://example.com?utm_medium=sms"})
+ |> assert_acquisition_channel("SMS")
+ end
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
+ test "parses mobile push notifications channel from utm_medium with push", %{site: site} do
+ site
+ |> submit_event(%{url: "http://example.com?utm_medium=app-push"})
+ |> assert_acquisition_channel("Mobile Push Notifications")
+ end
- [session] = get_sessions(site)
+ test "parses mobile push notifications channel from utm_medium", %{site: site} do
+ site
+ |> submit_event(%{url: "http://example.com?utm_medium=example-mobile"})
+ |> assert_acquisition_channel("Mobile Push Notifications")
+ end
- assert response(conn, 202) == "ok"
- assert session.acquisition_channel == "Paid Search"
- assert session.utm_medium == "cpc"
- assert session.click_id_param == "msclkid"
+ test "parses referral channel if session starts with a simple referral", %{site: site} do
+ site
+ |> submit_event(%{url: "http://example.com", referrer: "https://othersite.com"})
+ |> assert_acquisition_channel("Referral")
end
- test "does not override utm_medium with (msclkid) if link is already tagged", %{
- conn: conn,
+ test "parses direct channel if session starts without referrer or utm tags", %{
site: site
} do
- params = %{
+ site
+ |> submit_event(%{
name: "pageview",
- url: "http://example.com?gclid=123identifier&utm_medium=paidads",
- referrer: "https://google.com",
+ url: "http://example.com",
domain: site.domain
- }
-
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
-
- [session] = get_sessions(site)
+ })
+ |> assert_acquisition_channel("Direct")
+ end
+ end
- assert response(conn, 202) == "ok"
- assert session.acquisition_channel == "Paid Search"
- assert session.utm_medium == "paidads"
- assert session.click_id_param == "gclid"
+ describe "custom source parsing rules" do
+ setup do
+ site = new_site()
+ {:ok, site: site}
end
- test "parses paid search channel based on utm_source and medium", %{conn: conn, site: site} do
- params = %{
- name: "pageview",
- url: "http://example.com?utm_source=google&utm_medium=paid",
- domain: site.domain
- }
+ defp submit_event(site, params_overrides) do
+ params =
+ Map.merge(
+ %{name: "pageview", url: "http://example.com", domain: site.domain},
+ params_overrides
+ )
conn =
- conn
+ build_conn()
|> put_req_header("user-agent", @user_agent)
|> post("/api/event", params)
- [session] = get_sessions(site)
-
assert response(conn, 202) == "ok"
- assert session.acquisition_channel == "Paid Search"
- assert session.click_id_param == ""
- end
-
- test "parses paid social channel based on referrer and medium", %{conn: conn, site: site} do
- params = %{
- name: "pageview",
- url: "http://example.com?utm_medium=paid",
- referrer: "https://tiktok.com",
- domain: site.domain
- }
-
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
[session] = get_sessions(site)
+ session
+ end
- assert response(conn, 202) == "ok"
- assert session.acquisition_channel == "Paid Social"
+ defp event_with_referrer(site, referrer) do
+ submit_event(site, %{referrer: referrer})
end
- test "parses paid social channel based on utm_source and medium", %{conn: conn, site: site} do
- params = %{
- name: "pageview",
- url: "http://example.com?utm_source=tiktok&utm_medium=paid",
- domain: site.domain
- }
+ defp event_with_utm_source(site, utm_source) do
+ submit_event(site, %{url: "http://example.com?utm_source=#{utm_source}"})
+ end
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
+ defp assert_source(session, expected) do
+ assert session.referrer_source == expected
+ session
+ end
- [session] = get_sessions(site)
+ defp assert_utm_source(session, expected) do
+ assert session.utm_source == expected
+ session
+ end
- assert response(conn, 202) == "ok"
- assert session.acquisition_channel == "Paid Social"
+ defp assert_utm_medium(session, expected) do
+ assert session.utm_medium == expected
+ session
end
- test "parses paid video channel based on referrer and medium", %{conn: conn, site: site} do
- params = %{
- name: "pageview",
- url: "http://example.com?utm_medium=paid",
- referrer: "https://youtube.com",
- domain: site.domain
- }
+ defp assert_click_id_param(session, expected) do
+ assert session.click_id_param == expected
+ session
+ end
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
+ defp assert_acquisition_channel(session, expected) do
+ assert session.acquisition_channel == expected
+ session
+ end
- [session] = get_sessions(site)
+ test "threads is Threads", %{site: site} do
+ site
+ |> event_with_utm_source("threads")
+ |> assert_source("Threads")
+ |> assert_utm_source("threads")
+ |> assert_acquisition_channel("Organic Social")
+ end
- assert response(conn, 202) == "ok"
- assert session.acquisition_channel == "Paid Video"
+ test "ig is Instagram", %{site: site} do
+ site
+ |> event_with_utm_source("ig")
+ |> assert_source("Instagram")
+ |> assert_utm_source("ig")
+ |> assert_acquisition_channel("Organic Social")
end
- test "parses paid video channel based on utm_source and medium", %{conn: conn, site: site} do
- params = %{
- name: "pageview",
- url: "http://example.com?utm_source=youtube&utm_medium=paid",
- domain: site.domain
- }
+ test "yt is Youtube", %{site: site} do
+ site
+ |> event_with_utm_source("yt")
+ |> assert_source("Youtube")
+ |> assert_utm_source("yt")
+ |> assert_acquisition_channel("Organic Video")
+ end
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
+ test "yt-ads is Youtube paid", %{site: site} do
+ site
+ |> event_with_utm_source("yt-ads")
+ |> assert_source("Youtube")
+ |> assert_utm_source("yt-ads")
+ |> assert_acquisition_channel("Paid Video")
+ end
- [session] = get_sessions(site)
+ test "fb is Facebook", %{site: site} do
+ site
+ |> event_with_utm_source("fb")
+ |> assert_source("Facebook")
+ |> assert_utm_source("fb")
+ |> assert_acquisition_channel("Organic Social")
+ end
- assert response(conn, 202) == "ok"
- assert session.acquisition_channel == "Paid Video"
+ test "fb-ads is Facebook", %{site: site} do
+ site
+ |> event_with_utm_source("fb-ads")
+ |> assert_source("Facebook")
+ |> assert_utm_source("fb-ads")
+ |> assert_acquisition_channel("Paid Social")
end
- test "parses display channel", %{conn: conn, site: site} do
- params = %{
- name: "pageview",
- url: "http://example.com?utm_medium=banner",
- domain: site.domain
- }
-
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
-
- [session] = get_sessions(site)
-
- assert response(conn, 202) == "ok"
- assert session.acquisition_channel == "Display"
- end
-
- test "display channel with gclid", %{conn: conn, site: site} do
- params = %{
- name: "pageview",
- url: "http://example.com?utm_medium=display&utm_source=google&gclid=123identifier",
- domain: site.domain
- }
-
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
-
- [session] = get_sessions(site)
-
- assert response(conn, 202) == "ok"
- assert session.acquisition_channel == "Display"
- end
-
- test "parses paid other channel", %{conn: conn, site: site} do
- params = %{
- name: "pageview",
- url: "http://example.com?utm_medium=cpc",
- domain: site.domain
- }
-
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
-
- [session] = get_sessions(site)
-
- assert response(conn, 202) == "ok"
- assert session.acquisition_channel == "Paid Other"
- end
-
- test "parses organic shopping channel from referrer", %{conn: conn, site: site} do
- params = %{
- name: "pageview",
- url: "http://example.com",
- referrer: "https://walmart.com",
- domain: site.domain
- }
-
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
-
- [session] = get_sessions(site)
-
- assert response(conn, 202) == "ok"
- assert session.acquisition_channel == "Organic Shopping"
- end
-
- test "parses organic shopping channel from utm_source", %{conn: conn, site: site} do
- params = %{
- name: "pageview",
- url: "http://example.com?utm_source=walmart",
- domain: site.domain
- }
-
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
-
- [session] = get_sessions(site)
-
- assert response(conn, 202) == "ok"
- assert session.acquisition_channel == "Organic Shopping"
- end
-
- test "parses organic shopping channel from utm_campaign", %{conn: conn, site: site} do
- params = %{
- name: "pageview",
- url: "http://example.com?utm_campaign=shop",
- domain: site.domain
- }
-
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
-
- [session] = get_sessions(site)
-
- assert response(conn, 202) == "ok"
- assert session.acquisition_channel == "Organic Shopping"
- end
-
- test "parses organic social channel from referrer", %{conn: conn, site: site} do
- params = %{
- name: "pageview",
- url: "http://example.com",
- referrer: "http://facebook.com",
- domain: site.domain
- }
-
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
-
- [session] = get_sessions(site)
-
- assert response(conn, 202) == "ok"
- assert session.acquisition_channel == "Organic Social"
- end
-
- test "parses organic social channel from utm_source", %{conn: conn, site: site} do
- params = %{
- name: "pageview",
- url: "http://example.com?utm_source=twitter",
- domain: site.domain
- }
-
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
-
- [session] = get_sessions(site)
-
- assert response(conn, 202) == "ok"
- assert session.acquisition_channel == "Organic Social"
- end
-
- test "parses organic social channel from utm_medium", %{conn: conn, site: site} do
- params = %{
- name: "pageview",
- url: "http://example.com?utm_medium=social",
- domain: site.domain
- }
-
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
-
- [session] = get_sessions(site)
-
- assert response(conn, 202) == "ok"
- assert session.acquisition_channel == "Organic Social"
- end
-
- test "parses organic video channel from referrer", %{conn: conn, site: site} do
- params = %{
- name: "pageview",
- url: "http://example.com",
- referrer: "https://vimeo.com",
- domain: site.domain
- }
-
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
-
- [session] = get_sessions(site)
-
- assert response(conn, 202) == "ok"
- assert session.acquisition_channel == "Organic Video"
- end
-
- test "parses organic video channel from utm_source", %{conn: conn, site: site} do
- params = %{
- name: "pageview",
- url: "http://example.com?utm_source=vimeo",
- domain: site.domain
- }
-
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
-
- [session] = get_sessions(site)
-
- assert response(conn, 202) == "ok"
- assert session.acquisition_channel == "Organic Video"
- end
-
- test "parses organic video channel from utm_medium", %{conn: conn, site: site} do
- params = %{
- name: "pageview",
- url: "http://example.com?utm_medium=video",
- domain: site.domain
- }
-
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
-
- [session] = get_sessions(site)
-
- assert response(conn, 202) == "ok"
- assert session.acquisition_channel == "Organic Video"
- end
-
- test "parses organic search channel from referrer", %{conn: conn, site: site} do
- params = %{
- name: "pageview",
- url: "http://example.com",
- referrer: "http://duckduckgo.com",
- domain: site.domain
- }
-
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
-
- [session] = get_sessions(site)
-
- assert response(conn, 202) == "ok"
- assert session.acquisition_channel == "Organic Search"
- end
-
- test "parses organic search channel from utm_source", %{conn: conn, site: site} do
- params = %{
- name: "pageview",
- url: "http://example.com?utm_source=duckduckgo",
- domain: site.domain
- }
-
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
-
- [session] = get_sessions(site)
-
- assert response(conn, 202) == "ok"
- assert session.acquisition_channel == "Organic Search"
- end
-
- test "parses referral channel from utm_medium", %{conn: conn, site: site} do
- params = %{
- name: "pageview",
- url: "http://example.com?utm_medium=referral",
- domain: site.domain
- }
-
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
-
- [session] = get_sessions(site)
-
- assert response(conn, 202) == "ok"
- assert session.acquisition_channel == "Referral"
- end
-
- test "parses email channel from utm_source", %{conn: conn, site: site} do
- params = %{
- name: "pageview",
- url: "http://example.com?utm_source=email",
- domain: site.domain
- }
-
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
-
- [session] = get_sessions(site)
-
- assert response(conn, 202) == "ok"
- assert session.acquisition_channel == "Email"
- end
-
- test "parses email channel from utm_medium", %{conn: conn, site: site} do
- params = %{
- name: "pageview",
- url: "http://example.com?utm_medium=email",
- domain: site.domain
- }
-
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
-
- [session] = get_sessions(site)
-
- assert response(conn, 202) == "ok"
- assert session.acquisition_channel == "Email"
- end
-
- test "parses affiliates channel from utm_medium", %{conn: conn, site: site} do
- params = %{
- name: "pageview",
- url: "http://example.com?utm_medium=affiliate",
- domain: site.domain
- }
-
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
-
- [session] = get_sessions(site)
-
- assert response(conn, 202) == "ok"
- assert session.acquisition_channel == "Affiliates"
- end
-
- test "parses audio channel from utm_medium", %{conn: conn, site: site} do
- params = %{
- name: "pageview",
- url: "http://example.com?utm_medium=audio",
- domain: site.domain
- }
-
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
-
- [session] = get_sessions(site)
-
- assert response(conn, 202) == "ok"
- assert session.acquisition_channel == "Audio"
- end
-
- test "parses sms channel from utm_source", %{conn: conn, site: site} do
- params = %{
- name: "pageview",
- url: "http://example.com?utm_source=sms",
- domain: site.domain
- }
-
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
-
- [session] = get_sessions(site)
-
- assert response(conn, 202) == "ok"
- assert session.acquisition_channel == "SMS"
- end
-
- test "parses sms channel from utm_medium", %{conn: conn, site: site} do
- params = %{
- name: "pageview",
- url: "http://example.com?utm_medium=sms",
- domain: site.domain
- }
-
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
-
- [session] = get_sessions(site)
-
- assert response(conn, 202) == "ok"
- assert session.acquisition_channel == "SMS"
- end
-
- test "parses mobile push notifications channel from utm_medium with push", %{
- conn: conn,
- site: site
- } do
- params = %{
- name: "pageview",
- url: "http://example.com?utm_medium=app-push",
- domain: site.domain
- }
-
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
-
- [session] = get_sessions(site)
-
- assert response(conn, 202) == "ok"
- assert session.acquisition_channel == "Mobile Push Notifications"
- end
-
- test "parses mobile push notifications channel from utm_medium", %{conn: conn, site: site} do
- params = %{
- name: "pageview",
- url: "http://example.com?utm_medium=example-mobile",
- domain: site.domain
- }
-
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
-
- [session] = get_sessions(site)
-
- assert response(conn, 202) == "ok"
- assert session.acquisition_channel == "Mobile Push Notifications"
- end
-
- test "parses referral channel if session starts with a simple referral", %{
- conn: conn,
- site: site
- } do
- params = %{
- name: "pageview",
- url: "http://example.com",
- referrer: "https://othersite.com",
- domain: site.domain
- }
-
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
-
- [session] = get_sessions(site)
-
- assert response(conn, 202) == "ok"
- assert session.acquisition_channel == "Referral"
- end
-
- test "parses direct channel if session starts without referrer or utm tags", %{
- conn: conn,
- site: site
- } do
- params = %{
- name: "pageview",
- url: "http://example.com",
- domain: site.domain
- }
-
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
-
- [session] = get_sessions(site)
-
- assert response(conn, 202) == "ok"
- assert session.acquisition_channel == "Direct"
- end
- end
-
- describe "custom source parsing rules" do
- setup do
- site = new_site()
- {:ok, site: site}
- end
-
- test "threads is Threads", %{
- conn: conn,
- site: site
- } do
- params = %{
- name: "pageview",
- url: "http://example.com?utm_source=threads",
- domain: site.domain
- }
-
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
-
- [session] = get_sessions(site)
-
- assert response(conn, 202) == "ok"
- assert session.referrer_source == "Threads"
- assert session.utm_source == "threads"
- assert session.acquisition_channel == "Organic Social"
- end
-
- test "ig is Instagram", %{
- conn: conn,
- site: site
- } do
- params = %{
- name: "pageview",
- url: "http://example.com?utm_source=ig",
- domain: site.domain
- }
-
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
-
- [session] = get_sessions(site)
-
- assert response(conn, 202) == "ok"
- assert session.referrer_source == "Instagram"
- assert session.utm_source == "ig"
- assert session.acquisition_channel == "Organic Social"
- end
-
- test "yt is Youtube", %{
- conn: conn,
- site: site
- } do
- params = %{
- name: "pageview",
- url: "http://example.com?utm_source=yt",
- domain: site.domain
- }
-
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
-
- [session] = get_sessions(site)
-
- assert response(conn, 202) == "ok"
- assert session.referrer_source == "Youtube"
- assert session.utm_source == "yt"
- assert session.acquisition_channel == "Organic Video"
- end
-
- test "yt-ads is Youtube paid", %{
- conn: conn,
- site: site
- } do
- params = %{
- name: "pageview",
- url: "http://example.com?utm_source=yt-ads",
- domain: site.domain
- }
-
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
-
- [session] = get_sessions(site)
-
- assert response(conn, 202) == "ok"
- assert session.referrer_source == "Youtube"
- assert session.utm_source == "yt-ads"
- assert session.acquisition_channel == "Paid Video"
- end
-
- test "fb is Facebook", %{
- conn: conn,
- site: site
- } do
- params = %{
- name: "pageview",
- url: "http://example.com?utm_source=fb",
- domain: site.domain
- }
-
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
-
- [session] = get_sessions(site)
-
- assert response(conn, 202) == "ok"
- assert session.referrer_source == "Facebook"
- assert session.utm_source == "fb"
- assert session.acquisition_channel == "Organic Social"
- end
-
- test "fb-ads is Facebook", %{
- conn: conn,
- site: site
- } do
- params = %{
- name: "pageview",
- url: "http://example.com?utm_source=fb-ads",
- domain: site.domain
- }
-
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
-
- [session] = get_sessions(site)
-
- assert response(conn, 202) == "ok"
- assert session.referrer_source == "Facebook"
- assert session.utm_source == "fb-ads"
- assert session.acquisition_channel == "Paid Social"
- end
-
- test "fbad is Facebook", %{
- conn: conn,
- site: site
- } do
- params = %{
- name: "pageview",
- url: "http://example.com?utm_source=fbad",
- domain: site.domain
- }
-
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
-
- [session] = get_sessions(site)
-
- assert response(conn, 202) == "ok"
- assert session.referrer_source == "Facebook"
- assert session.utm_source == "fbad"
- assert session.acquisition_channel == "Paid Social"
- end
-
- test "facebook-ads is Facebook", %{
- conn: conn,
- site: site
- } do
- params = %{
- name: "pageview",
- url: "http://example.com?utm_source=facebook-ads",
- domain: site.domain
- }
-
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
-
- [session] = get_sessions(site)
-
- assert response(conn, 202) == "ok"
- assert session.referrer_source == "Facebook"
- assert session.utm_source == "facebook-ads"
- assert session.acquisition_channel == "Paid Social"
- end
-
- test "Reddit-ads is Reddit", %{
- conn: conn,
- site: site
- } do
- params = %{
- name: "pageview",
- url: "http://example.com?utm_source=Reddit-ads",
- domain: site.domain
- }
-
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
-
- [session] = get_sessions(site)
-
- assert response(conn, 202) == "ok"
- assert session.referrer_source == "Reddit"
- assert session.utm_source == "Reddit-ads"
- assert session.acquisition_channel == "Paid Social"
- end
-
- test "google_ads is Google", %{
- conn: conn,
- site: site
- } do
- params = %{
- name: "pageview",
- url: "http://example.com?utm_source=google_ads",
- domain: site.domain
- }
-
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
-
- [session] = get_sessions(site)
-
- assert response(conn, 202) == "ok"
- assert session.referrer_source == "Google"
- assert session.utm_source == "google_ads"
- assert session.acquisition_channel == "Paid Search"
- end
-
- test "Google-ads is Google", %{
- conn: conn,
- site: site
- } do
- params = %{
- name: "pageview",
- url: "http://example.com?source=Google-ads",
- domain: site.domain
- }
-
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
-
- [session] = get_sessions(site)
-
- assert response(conn, 202) == "ok"
- assert session.referrer_source == "Google"
- assert session.utm_source == "Google-ads"
- assert session.acquisition_channel == "Paid Search"
- end
-
- test "utm_source=Adwords is Google paid search", %{
- conn: conn,
- site: site
- } do
- params = %{
- name: "pageview",
- url: "http://example.com?utm_source=Adwords",
- domain: site.domain
- }
-
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
-
- [session] = get_sessions(site)
-
- assert response(conn, 202) == "ok"
- assert session.referrer_source == "Google"
- assert session.utm_source == "Adwords"
- assert session.acquisition_channel == "Paid Search"
- end
-
- test "twitter-ads is Twitter", %{
- conn: conn,
- site: site
- } do
- params = %{
- name: "pageview",
- url: "http://example.com?utm_source=twitter-ads",
- domain: site.domain
- }
-
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
-
- [session] = get_sessions(site)
-
- assert response(conn, 202) == "ok"
- assert session.referrer_source == "Twitter"
- assert session.utm_source == "twitter-ads"
- assert session.acquisition_channel == "Paid Social"
- end
-
- test "android-app://com.reddit.frontpage is Reddit", %{
- conn: conn,
- site: site
- } do
- params = %{
- name: "pageview",
- url: "http://example.com",
- referrer: "android-app://com.reddit.frontpage",
- domain: site.domain
- }
-
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
-
- [session] = get_sessions(site)
-
- assert response(conn, 202) == "ok"
- assert session.referrer_source == "Reddit"
- assert session.acquisition_channel == "Organic Social"
- end
-
- test "perplexity.ai is Perplexity", %{
- conn: conn,
- site: site
- } do
- params = %{
- name: "pageview",
- url: "http://example.com",
- referrer: "https://perplexity.ai",
- domain: site.domain
- }
-
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
-
- [session] = get_sessions(site)
-
- assert response(conn, 202) == "ok"
- assert session.referrer_source == "Perplexity"
- assert session.acquisition_channel == "Organic Search"
- end
-
- test "utm_source=perplexity is Perplexity", %{
- conn: conn,
- site: site
- } do
- params = %{
- name: "pageview",
- url: "http://example.com?utm_source=perplexity",
- domain: site.domain
- }
-
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
-
- [session] = get_sessions(site)
-
- assert response(conn, 202) == "ok"
- assert session.referrer_source == "Perplexity"
- assert session.acquisition_channel == "Organic Search"
- end
-
- test "statics.teams.cdn.office.net is Microsoft Teams", %{
- conn: conn,
- site: site
- } do
- params = %{
- name: "pageview",
- url: "http://example.com",
- referrer: "https://statics.teams.cdn.office.net",
- domain: site.domain
- }
-
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
-
- [session] = get_sessions(site)
-
- assert response(conn, 202) == "ok"
- assert session.referrer_source == "Microsoft Teams"
- assert session.acquisition_channel == "Organic Social"
- end
-
- test "wikipedia domain is resolved as Wikipedia", %{
- conn: conn,
- site: site
- } do
- params = %{
- name: "pageview",
- url: "http://example.com",
- referrer: "https://en.wikipedia.org",
- domain: site.domain
- }
-
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
-
- [session] = get_sessions(site)
-
- assert response(conn, 202) == "ok"
- assert session.referrer_source == "Wikipedia"
- assert session.acquisition_channel == "Referral"
- end
-
- test "ntp.msn.com is Bing", %{
- conn: conn,
- site: site
- } do
- params = %{
- name: "pageview",
- url: "http://example.com",
- referrer: "https://ntp.msn.com",
- domain: site.domain
- }
-
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
-
- [session] = get_sessions(site)
-
- assert response(conn, 202) == "ok"
- assert session.referrer_source == "Bing"
- assert session.acquisition_channel == "Organic Search"
- end
-
- test "search.brave.com is Brave", %{
- conn: conn,
- site: site
- } do
- params = %{
- name: "pageview",
- url: "http://example.com",
- referrer: "https://search.brave.com",
- domain: site.domain
- }
-
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
-
- [session] = get_sessions(site)
-
- assert response(conn, 202) == "ok"
- assert session.referrer_source == "Brave"
- assert session.acquisition_channel == "Organic Search"
- end
-
- test "yandex.com.tr is Yandex", %{
- conn: conn,
- site: site
- } do
- params = %{
- name: "pageview",
- url: "http://example.com",
- referrer: "https://yandex.com.tr",
- domain: site.domain
- }
-
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
-
- [session] = get_sessions(site)
-
- assert response(conn, 202) == "ok"
- assert session.referrer_source == "Yandex"
- assert session.acquisition_channel == "Organic Search"
- end
-
- test "yandex.kz is Yandex", %{
- conn: conn,
- site: site
- } do
- params = %{
- name: "pageview",
- url: "http://example.com",
- referrer: "https://yandex.kz",
- domain: site.domain
- }
-
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
-
- [session] = get_sessions(site)
-
- assert response(conn, 202) == "ok"
- assert session.referrer_source == "Yandex"
- assert session.acquisition_channel == "Organic Search"
- end
-
- test "ya.ru is Yandex", %{
- conn: conn,
- site: site
- } do
- params = %{
- name: "pageview",
- url: "http://example.com",
- referrer: "https://ya.ru",
- domain: site.domain
- }
-
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
-
- [session] = get_sessions(site)
-
- assert response(conn, 202) == "ok"
- assert session.referrer_source == "Yandex"
- assert session.acquisition_channel == "Organic Search"
- end
-
- test "yandex.uz is Yandex", %{
- conn: conn,
- site: site
- } do
- params = %{
- name: "pageview",
- url: "http://example.com",
- referrer: "https://yandex.uz",
- domain: site.domain
- }
-
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
-
- [session] = get_sessions(site)
-
- assert response(conn, 202) == "ok"
- assert session.referrer_source == "Yandex"
- assert session.acquisition_channel == "Organic Search"
- end
-
- test "yandex.fr is Yandex", %{
- conn: conn,
- site: site
- } do
- params = %{
- name: "pageview",
- url: "http://example.com",
- referrer: "https://yandex.fr",
- domain: site.domain
- }
-
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
-
- [session] = get_sessions(site)
-
- assert response(conn, 202) == "ok"
- assert session.referrer_source == "Yandex"
- assert session.acquisition_channel == "Organic Search"
- end
-
- test "yandex.eu is Yandex", %{
- conn: conn,
- site: site
- } do
- params = %{
- name: "pageview",
- url: "http://example.com",
- referrer: "https://yandex.eu",
- domain: site.domain
- }
-
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
-
- [session] = get_sessions(site)
-
- assert response(conn, 202) == "ok"
- assert session.referrer_source == "Yandex"
- assert session.acquisition_channel == "Organic Search"
- end
-
- test "yandex.tm is Yandex", %{
- conn: conn,
- site: site
- } do
- params = %{
- name: "pageview",
- url: "http://example.com",
- referrer: "https://yandex.tm",
- domain: site.domain
- }
-
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
-
- [session] = get_sessions(site)
-
- assert response(conn, 202) == "ok"
- assert session.referrer_source == "Yandex"
- assert session.acquisition_channel == "Organic Search"
- end
-
- test "discord.com is Discord", %{
- conn: conn,
- site: site
- } do
- params = %{
- name: "pageview",
- url: "http://example.com",
- referrer: "https://discord.com",
- domain: site.domain
- }
-
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
-
- [session] = get_sessions(site)
-
- assert response(conn, 202) == "ok"
- assert session.referrer_source == "Discord"
- assert session.acquisition_channel == "Organic Social"
- end
-
- test "discordapp.com is Discord", %{
- conn: conn,
- site: site
- } do
- params = %{
- name: "pageview",
- url: "http://example.com",
- referrer: "https://discordapp.com",
- domain: site.domain
- }
-
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
-
- [session] = get_sessions(site)
-
- assert response(conn, 202) == "ok"
- assert session.referrer_source == "Discord"
- assert session.acquisition_channel == "Organic Social"
- end
-
- test "canary.discord.com is Discord", %{
- conn: conn,
- site: site
- } do
- params = %{
- name: "pageview",
- url: "http://example.com",
- referrer: "https://canary.discord.com",
- domain: site.domain
- }
-
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
-
- [session] = get_sessions(site)
-
- assert response(conn, 202) == "ok"
- assert session.referrer_source == "Discord"
- assert session.acquisition_channel == "Organic Social"
- end
-
- test "ptb.discord.com is Discord", %{
- conn: conn,
- site: site
- } do
- params = %{
- name: "pageview",
- url: "http://example.com",
- referrer: "https://ptb.discord.com",
- domain: site.domain
- }
-
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
-
- [session] = get_sessions(site)
-
- assert response(conn, 202) == "ok"
- assert session.referrer_source == "Discord"
- assert session.acquisition_channel == "Organic Social"
- end
-
- test "www.baidu.com is Baidu", %{conn: conn, site: site} do
- params = %{
- name: "pageview",
- url: "http://example.com",
- referrer: "https://baidu.com",
- domain: site.domain
- }
-
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
-
- [session] = get_sessions(site)
-
- assert response(conn, 202) == "ok"
- assert session.referrer_source == "Baidu"
- assert session.acquisition_channel == "Organic Search"
- end
-
- test "t.me is Telegram", %{conn: conn, site: site} do
- params = %{
- name: "pageview",
- url: "http://example.com",
- referrer: "https://t.me",
- domain: site.domain
- }
-
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
-
- [session] = get_sessions(site)
-
- assert response(conn, 202) == "ok"
- assert session.referrer_source == "Telegram"
- assert session.acquisition_channel == "Organic Social"
- end
-
- test "webk.telegram.org is Telegram", %{conn: conn, site: site} do
- params = %{
- name: "pageview",
- url: "http://example.com",
- referrer: "https://webk.telegram.org",
- domain: site.domain
- }
-
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
-
- [session] = get_sessions(site)
-
- assert response(conn, 202) == "ok"
- assert session.referrer_source == "Telegram"
- assert session.acquisition_channel == "Organic Social"
- end
-
- test "sogou.com is Sogou", %{conn: conn, site: site} do
- params = %{
- name: "pageview",
- url: "http://example.com",
- referrer: "https://sogou.com",
- domain: site.domain
- }
-
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
-
- [session] = get_sessions(site)
-
- assert response(conn, 202) == "ok"
- assert session.referrer_source == "Sogou"
- assert session.acquisition_channel == "Organic Search"
- end
-
- test "m.sogou.com is Sogou", %{conn: conn, site: site} do
- params = %{
- name: "pageview",
- url: "http://example.com",
- referrer: "https://m.sogou.com",
- domain: site.domain
- }
-
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
-
- [session] = get_sessions(site)
-
- assert response(conn, 202) == "ok"
- assert session.referrer_source == "Sogou"
- assert session.acquisition_channel == "Organic Search"
+ test "fbad is Facebook", %{site: site} do
+ site
+ |> event_with_utm_source("fbad")
+ |> assert_source("Facebook")
+ |> assert_utm_source("fbad")
+ |> assert_acquisition_channel("Paid Social")
end
- test "wap.sogou.com is Sogou", %{conn: conn, site: site} do
- params = %{
- name: "pageview",
- url: "http://example.com",
- referrer: "https://wap.sogou.com",
- domain: site.domain
- }
-
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
-
- [session] = get_sessions(site)
-
- assert response(conn, 202) == "ok"
- assert session.referrer_source == "Sogou"
- assert session.acquisition_channel == "Organic Search"
+ test "facebook-ads is Facebook", %{site: site} do
+ site
+ |> event_with_utm_source("facebook-ads")
+ |> assert_source("Facebook")
+ |> assert_utm_source("facebook-ads")
+ |> assert_acquisition_channel("Paid Social")
end
- test "linktr.ee is Linktree", %{conn: conn, site: site} do
- params = %{
- name: "pageview",
- url: "http://example.com",
- referrer: "https://linktr.ee",
- domain: site.domain
- }
-
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
+ test "Reddit-ads is Reddit", %{site: site} do
+ site
+ |> event_with_utm_source("Reddit-ads")
+ |> assert_source("Reddit")
+ |> assert_utm_source("Reddit-ads")
+ |> assert_acquisition_channel("Paid Social")
+ end
- [session] = get_sessions(site)
+ test "google_ads is Google", %{site: site} do
+ site
+ |> event_with_utm_source("google_ads")
+ |> assert_source("Google")
+ |> assert_utm_source("google_ads")
+ |> assert_acquisition_channel("Paid Search")
+ end
- assert response(conn, 202) == "ok"
- assert session.referrer_source == "Linktree"
- assert session.acquisition_channel == "Referral"
+ test "Google-ads is Google", %{
+ site: site
+ } do
+ site
+ |> submit_event(%{url: "http://example.com?source=Google-ads"})
+ |> assert_source("Google")
+ |> assert_utm_source("Google-ads")
+ |> assert_acquisition_channel("Paid Search")
end
- test "linktree is Linktree", %{conn: conn, site: site} do
- params = %{
- name: "pageview",
- url: "http://example.com?utm_source=linktree",
- domain: site.domain
- }
+ test "utm_source=Adwords is Google paid search", %{site: site} do
+ site
+ |> event_with_utm_source("Adwords")
+ |> assert_source("Google")
+ |> assert_utm_source("Adwords")
+ |> assert_acquisition_channel("Paid Search")
+ end
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
+ test "twitter-ads is X (Twitter)", %{site: site} do
+ site
+ |> event_with_utm_source("twitter-ads")
+ |> assert_source("X (Twitter)")
+ |> assert_utm_source("twitter-ads")
+ |> assert_acquisition_channel("Paid Social")
+ end
- [session] = get_sessions(site)
+ test "android-app://com.reddit.frontpage is Reddit", %{site: site} do
+ site
+ |> event_with_referrer("android-app://com.reddit.frontpage")
+ |> assert_source("Reddit")
+ |> assert_acquisition_channel("Organic Social")
+ end
- assert response(conn, 202) == "ok"
- assert session.referrer_source == "Linktree"
- assert session.acquisition_channel == "Referral"
+ test "perplexity.ai is Perplexity", %{site: site} do
+ site
+ |> event_with_referrer("https://perplexity.ai")
+ |> assert_source("Perplexity")
+ |> assert_acquisition_channel("AI Assistants")
end
- end
- describe "custom channel parsing rules" do
- setup do
- site = new_site()
- {:ok, site: site}
+ test "pplx.ai is Perplexity", %{site: site} do
+ site
+ |> event_with_referrer("https://pplx.ai")
+ |> assert_source("Perplexity")
+ |> assert_acquisition_channel("AI Assistants")
end
- test "hacker news is social channel", %{
- conn: conn,
- site: site
- } do
- params = %{
- name: "pageview",
- url: "http://example.com",
- referrer: "https://news.ycombinator.com",
- domain: site.domain
- }
+ test "utm_source=perplexity is Perplexity", %{site: site} do
+ site
+ |> event_with_utm_source("perplexity")
+ |> assert_source("Perplexity")
+ |> assert_acquisition_channel("AI Assistants")
+ end
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
+ test "statics.teams.cdn.office.net is Microsoft Teams", %{site: site} do
+ site
+ |> event_with_referrer("https://statics.teams.cdn.office.net")
+ |> assert_source("Microsoft Teams")
+ |> assert_acquisition_channel("Organic Social")
+ end
- [session] = get_sessions(site)
+ test "wikipedia domain is resolved as Wikipedia", %{site: site} do
+ site
+ |> event_with_referrer("https://en.wikipedia.org")
+ |> assert_source("Wikipedia")
+ |> assert_acquisition_channel("Referral")
+ end
- assert response(conn, 202) == "ok"
- assert session.referrer_source == "Hacker News"
- assert session.acquisition_channel == "Organic Social"
+ test "ntp.msn.com is Bing", %{site: site} do
+ site
+ |> event_with_referrer("https://ntp.msn.com")
+ |> assert_source("Bing")
+ |> assert_acquisition_channel("Organic Search")
end
- test "yahoo is organic search", %{
- conn: conn,
- site: site
- } do
- params = %{
- name: "pageview",
- url: "http://example.com",
- referrer: "https://search.yahoo.com",
- domain: site.domain
- }
+ test "search.brave.com is Brave", %{site: site} do
+ site
+ |> event_with_referrer("https://search.brave.com")
+ |> assert_source("Brave")
+ |> assert_acquisition_channel("Organic Search")
+ end
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
+ test "yandex.com.tr is Yandex", %{site: site} do
+ site
+ |> event_with_referrer("https://yandex.com.tr")
+ |> assert_source("Yandex")
+ |> assert_acquisition_channel("Organic Search")
+ end
- [session] = get_sessions(site)
+ test "yandex.kz is Yandex", %{site: site} do
+ site
+ |> event_with_referrer("https://yandex.kz")
+ |> assert_source("Yandex")
+ |> assert_acquisition_channel("Organic Search")
+ end
- assert response(conn, 202) == "ok"
- assert session.referrer_source == "Yahoo!"
- assert session.acquisition_channel == "Organic Search"
+ test "ya.ru is Yandex", %{site: site} do
+ site
+ |> event_with_referrer("https://ya.ru")
+ |> assert_source("Yandex")
+ |> assert_acquisition_channel("Organic Search")
end
- test "gmail is email channel", %{
- conn: conn,
- site: site
- } do
- params = %{
- name: "pageview",
- url: "http://example.com",
- referrer: "https://mail.google.com",
- domain: site.domain
- }
+ test "yandex.uz is Yandex", %{site: site} do
+ site
+ |> event_with_referrer("https://yandex.uz")
+ |> assert_source("Yandex")
+ |> assert_acquisition_channel("Organic Search")
+ end
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
+ test "yandex.fr is Yandex", %{site: site} do
+ site
+ |> event_with_referrer("https://yandex.fr")
+ |> assert_source("Yandex")
+ |> assert_acquisition_channel("Organic Search")
+ end
- [session] = get_sessions(site)
+ test "yandex.eu is Yandex", %{site: site} do
+ site
+ |> event_with_referrer("https://yandex.eu")
+ |> assert_source("Yandex")
+ |> assert_acquisition_channel("Organic Search")
+ end
- assert response(conn, 202) == "ok"
- assert session.referrer_source == "Gmail"
- assert session.acquisition_channel == "Email"
+ test "yandex.tm is Yandex", %{site: site} do
+ site
+ |> event_with_referrer("https://yandex.tm")
+ |> assert_source("Yandex")
+ |> assert_acquisition_channel("Organic Search")
end
- test "utm_source=newsletter is email channel", %{
- conn: conn,
- site: site
- } do
- params = %{
- name: "pageview",
- url: "http://example.com?utm_source=Newsletter-UK",
- domain: site.domain
- }
+ test "discord.com is Discord", %{site: site} do
+ site
+ |> event_with_referrer("https://discord.com")
+ |> assert_source("Discord")
+ |> assert_acquisition_channel("Organic Social")
+ end
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
+ test "discordapp.com is Discord", %{site: site} do
+ site
+ |> event_with_referrer("https://discordapp.com")
+ |> assert_source("Discord")
+ |> assert_acquisition_channel("Organic Social")
+ end
- [session] = get_sessions(site)
+ test "canary.discord.com is Discord", %{site: site} do
+ site
+ |> event_with_referrer("https://canary.discord.com")
+ |> assert_source("Discord")
+ |> assert_acquisition_channel("Organic Social")
+ end
- assert response(conn, 202) == "ok"
- assert session.referrer_source == "Newsletter-UK"
- assert session.acquisition_channel == "Email"
+ test "ptb.discord.com is Discord", %{site: site} do
+ site
+ |> event_with_referrer("https://ptb.discord.com")
+ |> assert_source("Discord")
+ |> assert_acquisition_channel("Organic Social")
end
- test "temu.com is shopping channel", %{
- conn: conn,
- site: site
- } do
- params = %{
- name: "pageview",
- url: "http://example.com",
- referrer: "https://temu.com",
- domain: site.domain
- }
+ test "www.baidu.com is Baidu", %{site: site} do
+ site
+ |> event_with_referrer("https://baidu.com")
+ |> assert_source("Baidu")
+ |> assert_acquisition_channel("Organic Search")
+ end
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
+ test "t.me is Telegram", %{site: site} do
+ site
+ |> event_with_referrer("https://t.me")
+ |> assert_source("Telegram")
+ |> assert_acquisition_channel("Organic Social")
+ end
- [session] = get_sessions(site)
+ test "webk.telegram.org is Telegram", %{site: site} do
+ site
+ |> event_with_referrer("https://webk.telegram.org")
+ |> assert_source("Telegram")
+ |> assert_acquisition_channel("Organic Social")
+ end
- assert response(conn, 202) == "ok"
- assert session.referrer_source == "temu.com"
- assert session.acquisition_channel == "Organic Shopping"
+ test "sogou.com is Sogou", %{site: site} do
+ site
+ |> event_with_referrer("https://sogou.com")
+ |> assert_source("Sogou")
+ |> assert_acquisition_channel("Organic Search")
end
- test "utm_source=Telegram is social channel", %{
- conn: conn,
- site: site
- } do
- params = %{
- name: "pageview",
- url: "http://example.com?utm_source=Telegram",
- domain: site.domain
- }
+ test "m.sogou.com is Sogou", %{site: site} do
+ site
+ |> event_with_referrer("https://m.sogou.com")
+ |> assert_source("Sogou")
+ |> assert_acquisition_channel("Organic Search")
+ end
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
+ test "wap.sogou.com is Sogou", %{site: site} do
+ site
+ |> event_with_referrer("https://wap.sogou.com")
+ |> assert_source("Sogou")
+ |> assert_acquisition_channel("Organic Search")
+ end
- [session] = get_sessions(site)
+ test "linktr.ee is Linktree", %{site: site} do
+ site
+ |> event_with_referrer("https://linktr.ee")
+ |> assert_source("Linktree")
+ |> assert_acquisition_channel("Referral")
+ end
- assert response(conn, 202) == "ok"
- assert session.referrer_source == "Telegram"
- assert session.acquisition_channel == "Organic Social"
+ test "linktree is Linktree", %{site: site} do
+ site
+ |> event_with_utm_source("linktree")
+ |> assert_source("Linktree")
+ |> assert_acquisition_channel("Referral")
end
+ end
- test "chatgpt.com is search channel", %{
- conn: conn,
- site: site
- } do
- params = %{
- name: "pageview",
- url: "http://example.com",
- referrer: "https://chatgpt.com",
- domain: site.domain
- }
+ describe "custom channel parsing rules" do
+ setup do
+ site = new_site()
+ {:ok, site: site}
+ end
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
+ test "hacker news is social channel", %{site: site} do
+ site
+ |> event_with_referrer("https://news.ycombinator.com")
+ |> assert_source("Hacker News")
+ |> assert_acquisition_channel("Organic Social")
+ end
- [session] = get_sessions(site)
+ test "yahoo is organic search", %{site: site} do
+ site
+ |> event_with_referrer("https://search.yahoo.com")
+ |> assert_source("Yahoo!")
+ |> assert_acquisition_channel("Organic Search")
+ end
- assert response(conn, 202) == "ok"
- assert session.referrer_source == "chatgpt.com"
- assert session.acquisition_channel == "Organic Search"
+ test "gmail is email channel", %{site: site} do
+ site
+ |> event_with_referrer("https://mail.google.com")
+ |> assert_source("Gmail")
+ |> assert_acquisition_channel("Email")
end
- test "Slack is social channel", %{
- conn: conn,
- site: site
- } do
- params = %{
- name: "pageview",
- url: "http://example.com",
- referrer: "https://app.slack.com",
- domain: site.domain
- }
+ test "utm_source=newsletter is email channel", %{site: site} do
+ site
+ |> event_with_utm_source("Newsletter-UK")
+ |> assert_source("Newsletter-UK")
+ |> assert_acquisition_channel("Email")
+ end
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
+ test "temu.com is shopping channel", %{site: site} do
+ site
+ |> event_with_referrer("https://temu.com")
+ |> assert_source("temu.com")
+ |> assert_acquisition_channel("Organic Shopping")
+ end
- [session] = get_sessions(site)
+ test "utm_source=Telegram is social channel", %{site: site} do
+ site
+ |> event_with_utm_source("Telegram")
+ |> assert_source("Telegram")
+ |> assert_acquisition_channel("Organic Social")
+ end
- assert response(conn, 202) == "ok"
- assert session.referrer_source == "Slack"
- assert session.acquisition_channel == "Organic Social"
+ test "Slack is social channel", %{site: site} do
+ site
+ |> event_with_referrer("https://app.slack.com")
+ |> assert_source("Slack")
+ |> assert_acquisition_channel("Organic Social")
end
test "producthunt is social", %{
@@ -3381,119 +2227,144 @@ defmodule PlausibleWeb.Api.ExternalControllerTest do
assert session.acquisition_channel == "Organic Social"
end
- test "github is social", %{
- conn: conn,
- site: site
- } do
- params = %{
- name: "pageview",
- url: "http://example.com",
- referrer: "https://github.com",
- domain: site.domain
- }
+ test "github is social", %{site: site} do
+ site
+ |> event_with_referrer("https://github.com")
+ |> assert_source("GitHub")
+ |> assert_acquisition_channel("Organic Social")
+ end
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
+ test "steamcommunity.com is social", %{site: site} do
+ site
+ |> event_with_referrer("https://steamcommunity.com")
+ |> assert_source("steamcommunity.com")
+ |> assert_acquisition_channel("Organic Social")
+ end
- [session] = get_sessions(site)
+ test "Vkontakte is social", %{site: site} do
+ site
+ |> event_with_referrer("https://vkontakte.ru")
+ |> assert_source("Vkontakte")
+ |> assert_acquisition_channel("Organic Social")
+ end
- assert response(conn, 202) == "ok"
- assert session.referrer_source == "GitHub"
- assert session.acquisition_channel == "Organic Social"
+ test "Threads is social", %{site: site} do
+ site
+ |> event_with_referrer("https://threads.net")
+ |> assert_source("Threads")
+ |> assert_acquisition_channel("Organic Social")
end
- test "steamcommunity.com is social", %{
- conn: conn,
- site: site
- } do
- params = %{
- name: "pageview",
- url: "http://example.com",
- referrer: "https://steamcommunity.com",
- domain: site.domain
- }
+ test "Ecosia is search", %{site: site} do
+ site
+ |> event_with_referrer("https://ecosia.org")
+ |> assert_source("Ecosia")
+ |> assert_acquisition_channel("Organic Search")
+ end
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
+ test "bsky.app is Bluesky and Organic Social", %{site: site} do
+ site
+ |> event_with_referrer("https://bsky.app")
+ |> assert_source("Bluesky")
+ |> assert_acquisition_channel("Organic Social")
+ end
- [session] = get_sessions(site)
+ test "go.bsky.app is Bluesky and Organic Social", %{site: site} do
+ site
+ |> event_with_referrer("https://go.bsky.app")
+ |> assert_source("Bluesky")
+ |> assert_acquisition_channel("Organic Social")
+ end
- assert response(conn, 202) == "ok"
- assert session.referrer_source == "steamcommunity.com"
- assert session.acquisition_channel == "Organic Social"
+ test "mastodon.social is Mastodon and Organic Social", %{site: site} do
+ site
+ |> event_with_referrer("https://mastodon.social")
+ |> assert_source("Mastodon")
+ |> assert_acquisition_channel("Organic Social")
end
- test "Vkontakte is social", %{
- conn: conn,
- site: site
- } do
- params = %{
- name: "pageview",
- url: "http://example.com",
- referrer: "https://vkontakte.ru",
- domain: site.domain
- }
+ test "fosstodon.org is Mastodon and Organic Social", %{site: site} do
+ site
+ |> event_with_referrer("https://fosstodon.org")
+ |> assert_source("Mastodon")
+ |> assert_acquisition_channel("Organic Social")
+ end
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
+ test "gemini.google.com is Google Gemini and AI Assistants", %{site: site} do
+ site
+ |> event_with_referrer("https://gemini.google.com")
+ |> assert_source("Google Gemini")
+ |> assert_acquisition_channel("AI Assistants")
+ end
- [session] = get_sessions(site)
+ test "chatgpt.com is ChatGPT and AI Assistants", %{site: site} do
+ site
+ |> event_with_referrer("https://chatgpt.com")
+ |> assert_source("ChatGPT")
+ |> assert_acquisition_channel("AI Assistants")
+ end
- assert response(conn, 202) == "ok"
- assert session.referrer_source == "Vkontakte"
- assert session.acquisition_channel == "Organic Social"
+ test "chat.openai.com is ChatGPT and AI Assistants", %{site: site} do
+ site
+ |> event_with_referrer("https://chat.openai.com")
+ |> assert_source("ChatGPT")
+ |> assert_acquisition_channel("AI Assistants")
end
- test "Threads is social", %{
- conn: conn,
- site: site
- } do
- params = %{
- name: "pageview",
- url: "http://example.com",
- referrer: "https://threads.net",
- domain: site.domain
- }
+ test "claude.ai is Claude and AI Assistants", %{site: site} do
+ site
+ |> event_with_referrer("https://claude.ai")
+ |> assert_source("Claude")
+ |> assert_acquisition_channel("AI Assistants")
+ end
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
+ test "phind.com is Phind and AI Assistants", %{site: site} do
+ site
+ |> event_with_referrer("https://phind.com")
+ |> assert_source("Phind")
+ |> assert_acquisition_channel("AI Assistants")
+ end
- [session] = get_sessions(site)
+ test "copilot.microsoft.com is Microsoft Copilot and AI Assistants", %{site: site} do
+ site
+ |> event_with_referrer("https://copilot.microsoft.com")
+ |> assert_source("Microsoft Copilot")
+ |> assert_acquisition_channel("AI Assistants")
+ end
- assert response(conn, 202) == "ok"
- assert session.referrer_source == "Threads"
- assert session.acquisition_channel == "Organic Social"
+ test "copilot.com is Microsoft Copilot and AI Assistants", %{site: site} do
+ site
+ |> event_with_referrer("https://copilot.com")
+ |> assert_source("Microsoft Copilot")
+ |> assert_acquisition_channel("AI Assistants")
end
- test "Ecosia is search", %{
- conn: conn,
- site: site
- } do
- params = %{
- name: "pageview",
- url: "http://example.com",
- referrer: "https://ecosia.org",
- domain: site.domain
- }
+ test "x.com is X (Twitter) and Organic Social", %{site: site} do
+ site
+ |> event_with_referrer("https://x.com")
+ |> assert_source("X (Twitter)")
+ |> assert_acquisition_channel("Organic Social")
+ end
- conn =
- conn
- |> put_req_header("user-agent", @user_agent)
- |> post("/api/event", params)
+ test "l.threads.com is Threads and Organic Social", %{site: site} do
+ site
+ |> event_with_referrer("https://l.threads.com")
+ |> assert_source("Threads")
+ |> assert_acquisition_channel("Organic Social")
+ end
- [session] = get_sessions(site)
+ test "kagi.com is Kagi and Organic Search", %{site: site} do
+ site
+ |> event_with_referrer("https://kagi.com")
+ |> assert_source("Kagi")
+ |> assert_acquisition_channel("Organic Search")
+ end
- assert response(conn, 202) == "ok"
- assert session.referrer_source == "Ecosia"
- assert session.acquisition_channel == "Organic Search"
+ test "officeapps.live.com subdomains are Microsoft 365 and Referral", %{site: site} do
+ site
+ |> event_with_referrer("https://cac-excel.officeapps.live.com")
+ |> assert_source("Microsoft 365")
+ |> assert_acquisition_channel("Referral")
end
end
diff --git a/test/plausible_web/controllers/api/stats_controller/imported_test.exs b/test/plausible_web/controllers/api/stats_controller/imported_test.exs
index 733f884832..87adb949cb 100644
--- a/test/plausible_web/controllers/api/stats_controller/imported_test.exs
+++ b/test/plausible_web/controllers/api/stats_controller/imported_test.exs
@@ -305,7 +305,7 @@ defmodule PlausibleWeb.Api.StatsController.ImportedTest do
%{"name" => "Direct / None", "visitors" => 1, "percentage" => 11.11},
%{"name" => "DuckDuckGo", "visitors" => 2, "percentage" => 22.22},
%{"name" => "Google", "visitors" => 4, "percentage" => 44.44},
- %{"name" => "Twitter", "visitors" => 1, "percentage" => 11.11}
+ %{"name" => "X (Twitter)", "visitors" => 1, "percentage" => 11.11}
]
end
diff --git a/test/plausible_web/plugs/favicon_test.exs b/test/plausible_web/plugs/favicon_test.exs
index ed9f449bb5..964cf39bcc 100644
--- a/test/plausible_web/plugs/favicon_test.exs
+++ b/test/plausible_web/plugs/favicon_test.exs
@@ -94,6 +94,33 @@ defmodule PlausibleWeb.FaviconTest do
assert conn.resp_body == "favicon response body"
end
+ for {source, domain} <- %{
+ "Linktree" => "linktr.ee",
+ "Bluesky" => "bsky.app",
+ "Mastodon" => "mastodon.social",
+ "X (Twitter)" => "x.com",
+ "Kagi" => "kagi.com",
+ "Microsoft 365" => "office.com"
+ } do
+ test "maps custom source #{source} to #{domain} for favicon", %{plug_opts: plug_opts} do
+ expect(
+ Plausible.HTTPClient.Mock,
+ :get,
+ fn "https://icons.duckduckgo.com/ip3/#{unquote(domain)}.ico" ->
+ {:ok, %Finch.Response{status: 200, body: "favicon response body"}}
+ end
+ )
+
+ conn =
+ conn(:get, "/favicon/sources/#{URI.encode_www_form(unquote(source))}")
+ |> Favicon.call(plug_opts)
+
+ assert conn.halted
+ assert conn.status == 200
+ assert conn.resp_body == "favicon response body"
+ end
+ end
+
test "copies content-type header from the proxied response", %{plug_opts: plug_opts} do
expect(
Plausible.HTTPClient.Mock,