Open source, privacy-first web analytics. Lightweight, cookie-free Google Analytics alternative. Self-hosted or cloud.
TypeScript analyticsanalytics-dashboardclickhouseelixirgoogle-analyticsmarketingopen-source-analyticsphoenixplausible-analyticspostgresqlprivacyprivacy-friendlyself-hostedsimple-analyticsstatisticstailwindcssweb-analyticswebsite-analyticswebsite-statswebsite-tracking
defmodule PlausibleWeb.Api.ExternalStatsController.BreakdownTest do
use PlausibleWeb.ConnCase
alias Plausible.Billing.Feature
@user_id Enum.random(1000..9999)
setup [:create_user, :create_site, :create_api_key, :use_api_key]
describe "feature access" do
test "cannot break down by a custom prop without access to the props feature", %{
conn: conn,
user: user,
site: site
} do
subscribe_to_enterprise_plan(user, features: [Feature.StatsAPI])
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"property" => "event:props:author"
})
assert json_response(conn, 402)["error"] ==
"The owner of this site does not have access to the custom properties feature"
end
test "can break down by an internal prop key without access to the props feature", %{
conn: conn,
user: user,
site: site
} do
subscribe_to_enterprise_plan(user, features: [Feature.StatsAPI])
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"property" => "event:props:path"
})
assert json_response(conn, 200)["results"]
end
test "cannot filter by a custom prop without access to the props feature", %{
conn: conn,
user: user,
site: site
} do
subscribe_to_enterprise_plan(user, features: [Feature.StatsAPI])
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"property" => "visit:source",
"filters" => "event:props:author==Uku"
})
assert json_response(conn, 402)["error"] ==
"The owner of this site does not have access to the custom properties feature"
end
test "can filter by an internal prop key without access to the props feature", %{
conn: conn,
user: user,
site: site
} do
subscribe_to_enterprise_plan(user, features: [Feature.StatsAPI])
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"property" => "visit:source",
"filters" => "event:props:url==whatever"
})
assert json_response(conn, 200)["results"]
end
end
describe "param validation" do
test "time_on_page is not supported in breakdown queries other than by event:page", %{
conn: conn,
site: site
} do
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"property" => "visit:source",
"filters" => "event:page==/A",
"metrics" => "time_on_page"
})
assert json_response(conn, 400) == %{
"error" =>
"Metric `time_on_page` is not supported in breakdown queries (except `event:page` breakdown)"
}
end
test "does not allow querying conversion_rate without a goal filter", %{
conn: conn,
site: site
} do
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"property" => "event:page",
"metrics" => "conversion_rate"
})
assert json_response(conn, 400) == %{
"error" =>
"Metric `conversion_rate` can only be queried in a goal breakdown or with a goal filter"
}
end
test "validates that property is required", %{conn: conn, site: site} do
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain
})
assert json_response(conn, 400) == %{
"error" =>
"The `property` parameter is required. Please provide at least one property to show a breakdown by."
}
end
test "validates that property is valid", %{conn: conn, site: site} do
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"property" => "badproperty"
})
assert json_response(conn, 400) == %{
"error" =>
"Invalid property 'badproperty'. Please provide a valid property for the breakdown endpoint: https://plausible.io/docs/stats-api#properties"
}
end
test "empty custom prop is invalid", %{conn: conn, site: site} do
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"property" => "event:props:"
})
assert json_response(conn, 400) == %{
"error" =>
"Invalid property 'event:props:'. Please provide a valid property for the breakdown endpoint: https://plausible.io/docs/stats-api#properties"
}
end
test "validates that correct period is used", %{conn: conn, site: site} do
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"period" => "bad_period"
})
assert json_response(conn, 400) == %{
"error" =>
"Error parsing `period` parameter: invalid period `bad_period`. Please find accepted values in our docs: https://plausible.io/docs/stats-api#time-periods"
}
end
test "fails when an invalid metric is provided", %{conn: conn, site: site} do
conn =
get(conn, "/api/v1/stats/breakdown", %{
"property" => "event:page",
"metrics" => "visitors,baa",
"site_id" => site.domain
})
assert json_response(conn, 400) == %{
"error" =>
"The metric `baa` is not recognized. Find valid metrics from the documentation: https://plausible.io/docs/stats-api#metrics"
}
end
test "session metrics cannot be used with event:name property", %{conn: conn, site: site} do
conn =
get(conn, "/api/v1/stats/breakdown", %{
"property" => "event:name",
"metrics" => "visitors,bounce_rate",
"site_id" => site.domain
})
assert json_response(conn, 400) == %{
"error" =>
"Session metric `bounce_rate` cannot be queried for breakdown by `event:name`."
}
end
test "session metrics cannot be used with event:props:* property", %{conn: conn, site: site} do
conn =
get(conn, "/api/v1/stats/breakdown", %{
"property" => "event:props:url",
"metrics" => "visitors,bounce_rate",
"site_id" => site.domain
})
assert json_response(conn, 400) == %{
"error" =>
"Session metric `bounce_rate` cannot be queried for breakdown by `event:props:url`."
}
end
test "session metrics cannot be used with event:name filter", %{conn: conn, site: site} do
conn =
get(conn, "/api/v1/stats/breakdown", %{
"property" => "event:page",
"filters" => "event:name==Signup",
"metrics" => "visitors,bounce_rate",
"site_id" => site.domain
})
assert json_response(conn, 400) == %{
"error" =>
"Session metric `bounce_rate` cannot be queried when using a filter on `event:name`."
}
end
test "session metrics cannot be used with event:props:* filter", %{conn: conn, site: site} do
conn =
get(conn, "/api/v1/stats/breakdown", %{
"property" => "event:page",
"filters" => "event:props:url==google.com",
"metrics" => "visitors,bounce_rate",
"site_id" => site.domain
})
assert json_response(conn, 400) == %{
"error" =>
"Session metric `bounce_rate` cannot be queried when using a filter on `event:props:url`."
}
end
end
test "breakdown by visit:source", %{conn: conn, site: site} do
populate_stats(site, [
build(:pageview,
referrer_source: "Google",
timestamp: ~N[2021-01-01 00:00:00]
),
build(:pageview,
referrer_source: "Google",
timestamp: ~N[2021-01-01 00:25:00]
),
build(:pageview,
referrer_source: "",
timestamp: ~N[2021-01-01 00:00:00]
)
])
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"period" => "day",
"date" => "2021-01-01",
"property" => "visit:source"
})
assert json_response(conn, 200) == %{
"results" => [
%{"source" => "Google", "visitors" => 2},
%{"source" => "Direct / None", "visitors" => 1}
]
}
end
test "breakdown by visit:channel", %{conn: conn, site: site} do
populate_stats(site, [
build(:pageview,
referrer_source: "Bing",
timestamp: ~N[2021-01-01 00:00:00]
),
build(:pageview,
referrer_source: "Bing",
timestamp: ~N[2021-01-01 00:25:00]
),
build(:pageview,
timestamp: ~N[2021-01-01 00:00:00]
)
])
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"period" => "day",
"date" => "2021-01-01",
"property" => "visit:channel"
})
assert json_response(conn, 200) == %{
"results" => [
%{"channel" => "Organic Search", "visitors" => 2},
%{"channel" => "Direct", "visitors" => 1}
]
}
end
test "breakdown by visit:country", %{conn: conn, site: site} do
populate_stats(site, [
build(:pageview, country_code: "EE", timestamp: ~N[2021-01-01 00:00:00]),
build(:pageview, country_code: "EE", timestamp: ~N[2021-01-01 00:25:00]),
build(:pageview, country_code: "US", timestamp: ~N[2021-01-01 00:00:00])
])
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"period" => "day",
"date" => "2021-01-01",
"property" => "visit:country"
})
assert json_response(conn, 200) == %{
"results" => [
%{"country" => "EE", "visitors" => 2},
%{"country" => "US", "visitors" => 1}
]
}
end
test "breakdown by visit:referrer", %{conn: conn, site: site} do
populate_stats(site, [
build(:pageview,
referrer: "https://ref.com",
timestamp: ~N[2021-01-01 00:00:00]
),
build(:pageview,
referrer: "https://ref.com",
timestamp: ~N[2021-01-01 00:25:00]
),
build(:pageview,
referrer: "",
timestamp: ~N[2021-01-01 00:00:00]
)
])
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"period" => "day",
"date" => "2021-01-01",
"property" => "visit:referrer"
})
assert json_response(conn, 200) == %{
"results" => [
%{"referrer" => "https://ref.com", "visitors" => 2},
%{"referrer" => "Direct / None", "visitors" => 1}
]
}
end
test "breaks down all metrics by visit:referrer with imported data", %{conn: conn, site: site} do
site_import =
insert(:site_import,
site: site,
start_date: ~D[2005-01-01],
end_date: Date.utc_today(),
source: :universal_analytics
)
populate_stats(site, site_import.id, [
build(:pageview, referrer: "site.com", timestamp: ~N[2021-01-01 00:00:00]),
build(:pageview, referrer: "site.com/1", timestamp: ~N[2021-01-01 00:00:00]),
build(:imported_sources,
referrer: "site.com",
date: ~D[2021-01-01],
visitors: 2,
visits: 2,
pageviews: 2,
bounces: 1,
visit_duration: 120
),
build(:imported_sources,
referrer: "site.com/2",
date: ~D[2021-01-01],
visitors: 2,
visits: 2,
pageviews: 2,
bounces: 2,
visit_duration: 0
),
build(:imported_sources,
date: ~D[2021-01-01],
visitors: 10,
visits: 11,
pageviews: 50,
bounces: 0,
visit_duration: 1100
)
])
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"period" => "day",
"metrics" => "visitors,visits,pageviews,bounce_rate,visit_duration",
"date" => "2021-01-01",
"property" => "visit:referrer",
"with_imported" => "true"
})
assert json_response(conn, 200) == %{
"results" => [
%{
"referrer" => "Direct / None",
"visitors" => 10,
"visits" => 11,
"pageviews" => 50,
"bounce_rate" => 0,
"visit_duration" => 100
},
%{
"referrer" => "site.com",
"visitors" => 3,
"visits" => 3,
"pageviews" => 3,
"bounce_rate" => 67.0,
"visit_duration" => 40
},
%{
"referrer" => "site.com/2",
"visitors" => 2,
"visits" => 2,
"pageviews" => 2,
"bounce_rate" => 100.0,
"visit_duration" => 0
},
%{
"referrer" => "site.com/1",
"visitors" => 1,
"visits" => 1,
"pageviews" => 1,
"bounce_rate" => 100.0,
"visit_duration" => 0
}
]
}
end
for {property, attr} <- [
{"visit:utm_campaign", :utm_campaign},
{"visit:utm_source", :utm_source},
{"visit:utm_term", :utm_term},
{"visit:utm_content", :utm_content}
] do
test "breakdown by #{property} when filtered by hostname", %{conn: conn, site: site} do
populate_stats(site, [
# session starts at two.example.com with utm_param=ad
build(
:pageview,
[
{unquote(attr), "ad"},
{:user_id, @user_id},
{:hostname, "two.example.com"},
{:timestamp, ~N[2021-01-01 00:00:00]}
]
),
# session continues on one.example.com without any utm_params
build(
:pageview,
[
{:user_id, @user_id},
{:hostname, "one.example.com"},
{:timestamp, ~N[2021-01-01 00:15:00]}
]
)
])
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"period" => "day",
"date" => "2021-01-01",
"filters" => "event:hostname==one.example.com",
"property" => unquote(property)
})
# nobody landed on one.example.com from utm_param=ad
assert json_response(conn, 200) == %{"results" => []}
end
end
test "breakdown by visit:utm_medium", %{conn: conn, site: site} do
populate_stats(site, [
build(:pageview,
utm_medium: "Search",
timestamp: ~N[2021-01-01 00:00:00]
),
build(:pageview,
utm_medium: "Search",
timestamp: ~N[2021-01-01 00:25:00]
),
build(:pageview,
utm_medium: "",
timestamp: ~N[2021-01-01 00:00:00]
)
])
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"period" => "day",
"date" => "2021-01-01",
"property" => "visit:utm_medium"
})
assert json_response(conn, 200) == %{
"results" => [
%{"utm_medium" => "Search", "visitors" => 2}
]
}
end
test "breakdown by visit:utm_source", %{conn: conn, site: site} do
populate_stats(site, [
build(:pageview,
utm_source: "Google",
timestamp: ~N[2021-01-01 00:00:00]
),
build(:pageview,
utm_source: "Google",
timestamp: ~N[2021-01-01 00:25:00]
),
build(:pageview,
utm_source: "",
timestamp: ~N[2021-01-01 00:00:00]
)
])
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"period" => "day",
"date" => "2021-01-01",
"property" => "visit:utm_source"
})
assert json_response(conn, 200) == %{
"results" => [
%{"utm_source" => "Google", "visitors" => 2}
]
}
end
test "breaks down all metrics by visit:utm_source with imported data", %{conn: conn, site: site} do
site_import =
insert(:site_import,
site: site,
start_date: ~D[2005-01-01],
end_date: Date.utc_today(),
source: :universal_analytics
)
populate_stats(site, site_import.id, [
build(:pageview, utm_source: "SomeUTMSource", timestamp: ~N[2021-01-01 00:00:00]),
build(:pageview, utm_source: "SomeUTMSource-1", timestamp: ~N[2021-01-01 00:00:00]),
build(:imported_sources,
utm_source: "SomeUTMSource",
date: ~D[2021-01-01],
visitors: 2,
visits: 2,
pageviews: 2,
bounces: 1,
visit_duration: 120
),
build(:imported_sources,
utm_source: "SomeUTMSource-2",
date: ~D[2021-01-01],
visitors: 2,
visits: 2,
pageviews: 2,
bounces: 2,
visit_duration: 0
),
build(:imported_sources,
date: ~D[2021-01-01],
visitors: 10,
visits: 11,
pageviews: 50,
bounces: 0,
visit_duration: 1100
)
])
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"period" => "day",
"metrics" => "visitors,visits,pageviews,bounce_rate,visit_duration",
"date" => "2021-01-01",
"property" => "visit:utm_source",
"with_imported" => "true"
})
assert json_response(conn, 200) == %{
"results" => [
%{
"utm_source" => "SomeUTMSource",
"visitors" => 3,
"visits" => 3,
"pageviews" => 3,
"bounce_rate" => 67.0,
"visit_duration" => 40
},
%{
"utm_source" => "SomeUTMSource-2",
"visitors" => 2,
"visits" => 2,
"pageviews" => 2,
"bounce_rate" => 100.0,
"visit_duration" => 0
},
%{
"utm_source" => "SomeUTMSource-1",
"visitors" => 1,
"visits" => 1,
"pageviews" => 1,
"bounce_rate" => 100.0,
"visit_duration" => 0
}
]
}
end
test "breakdown by visit:utm_campaign", %{conn: conn, site: site} do
populate_stats(site, [
build(:pageview,
utm_campaign: "ads",
timestamp: ~N[2021-01-01 00:00:00]
),
build(:pageview,
utm_campaign: "ads",
timestamp: ~N[2021-01-01 00:25:00]
),
build(:pageview,
utm_campaign: "",
timestamp: ~N[2021-01-01 00:00:00]
)
])
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"period" => "day",
"date" => "2021-01-01",
"property" => "visit:utm_campaign"
})
assert json_response(conn, 200) == %{
"results" => [
%{"utm_campaign" => "ads", "visitors" => 2}
]
}
end
test "breakdown by visit:utm_content", %{conn: conn, site: site} do
populate_stats(site, [
build(:pageview,
utm_content: "Content1",
timestamp: ~N[2021-01-01 00:00:00]
),
build(:pageview,
utm_content: "Content1",
timestamp: ~N[2021-01-01 00:25:00]
),
build(:pageview,
utm_content: "",
timestamp: ~N[2021-01-01 00:00:00]
)
])
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"period" => "day",
"date" => "2021-01-01",
"property" => "visit:utm_content"
})
assert json_response(conn, 200) == %{
"results" => [
%{"utm_content" => "Content1", "visitors" => 2}
]
}
end
test "breakdown by visit:utm_term", %{conn: conn, site: site} do
populate_stats(site, [
build(:pageview,
utm_term: "Term1",
timestamp: ~N[2021-01-01 00:00:00]
),
build(:pageview,
utm_term: "Term1",
timestamp: ~N[2021-01-01 00:25:00]
),
build(:pageview,
utm_term: "",
timestamp: ~N[2021-01-01 00:00:00]
)
])
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"period" => "day",
"date" => "2021-01-01",
"property" => "visit:utm_term"
})
assert json_response(conn, 200) == %{
"results" => [
%{"utm_term" => "Term1", "visitors" => 2}
]
}
end
test "breakdown by visit:device", %{conn: conn, site: site} do
populate_stats(site, [
build(:pageview,
screen_size: "Desktop",
timestamp: ~N[2021-01-01 00:00:00]
),
build(:pageview,
screen_size: "Desktop",
timestamp: ~N[2021-01-01 00:25:00]
),
build(:pageview,
screen_size: "Mobile",
timestamp: ~N[2021-01-01 00:00:00]
)
])
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"period" => "day",
"date" => "2021-01-01",
"property" => "visit:device"
})
assert json_response(conn, 200) == %{
"results" => [
%{"device" => "Desktop", "visitors" => 2},
%{"device" => "Mobile", "visitors" => 1}
]
}
end
test "breakdown by visit:os", %{conn: conn, site: site} do
populate_stats(site, [
build(:pageview,
operating_system: "Mac",
timestamp: ~N[2021-01-01 00:00:00]
),
build(:pageview,
operating_system: "Mac",
timestamp: ~N[2021-01-01 00:25:00]
),
build(:pageview,
operating_system: "Windows",
timestamp: ~N[2021-01-01 00:00:00]
)
])
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"period" => "day",
"date" => "2021-01-01",
"property" => "visit:os"
})
assert json_response(conn, 200) == %{
"results" => [
%{"os" => "Mac", "visitors" => 2},
%{"os" => "Windows", "visitors" => 1}
]
}
end
test "breakdown by visit:os_version", %{conn: conn, site: site} do
populate_stats(site, [
build(:pageview, operating_system: "Mac", operating_system_version: "14"),
build(:pageview, operating_system: "Mac", operating_system_version: "14"),
build(:pageview, operating_system: "Mac", operating_system_version: "14"),
build(:pageview, operating_system_version: "14"),
build(:pageview,
operating_system: "Windows",
operating_system_version: "11"
),
build(:pageview,
operating_system: "Windows",
operating_system_version: "11"
)
])
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"period" => "day",
"property" => "visit:os_version"
})
assert json_response(conn, 200) == %{
"results" => [
%{"os_version" => "14", "visitors" => 3, "os" => "Mac"},
%{"os_version" => "11", "visitors" => 2, "os" => "Windows"},
%{"os_version" => "14", "visitors" => 1, "os" => "(not set)"}
]
}
end
test "breakdown by visit:browser", %{conn: conn, site: site} do
populate_stats(site, [
build(:pageview, browser: "Firefox", timestamp: ~N[2021-01-01 00:00:00]),
build(:pageview, browser: "Firefox", timestamp: ~N[2021-01-01 00:25:00]),
build(:pageview, browser: "Safari", timestamp: ~N[2021-01-01 00:00:00])
])
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"period" => "day",
"date" => "2021-01-01",
"property" => "visit:browser"
})
assert json_response(conn, 200) == %{
"results" => [
%{"browser" => "Firefox", "visitors" => 2},
%{"browser" => "Safari", "visitors" => 1}
]
}
end
test "breakdown by visit:browser_version", %{conn: conn, site: site} do
populate_stats(site, [
build(:pageview,
browser_version: "56",
timestamp: ~N[2021-01-01 00:00:00]
),
build(:pageview,
browser_version: "56",
timestamp: ~N[2021-01-01 00:25:00]
),
build(:pageview,
browser_version: "57",
timestamp: ~N[2021-01-01 00:00:00]
)
])
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"period" => "day",
"date" => "2021-01-01",
"property" => "visit:browser_version"
})
assert json_response(conn, 200) == %{
"results" => [
%{"browser_version" => "56", "visitors" => 2, "browser" => "(not set)"},
%{"browser_version" => "57", "visitors" => 1, "browser" => "(not set)"}
]
}
end
test "pageviews breakdown by event:page - imported data having pageviews=0 and visitors=n should be bypassed",
%{conn: conn, site: site} do
site_import =
insert(:site_import,
site: site,
start_date: ~D[2005-01-01],
end_date: Date.utc_today(),
source: :universal_analytics
)
populate_stats(site, site_import.id, [
build(:pageview, pathname: "/", timestamp: ~N[2021-01-01 00:00:00]),
build(:pageview, pathname: "/", timestamp: ~N[2021-01-01 00:25:00]),
build(:pageview,
pathname: "/plausible.io",
timestamp: ~N[2021-01-01 00:00:00]
),
build(:imported_pages,
page: "/skip-me",
date: ~D[2021-01-01],
visitors: 1,
pageviews: 0
),
build(:imported_pages,
page: "/include-me",
date: ~D[2021-01-01],
visitors: 1,
pageviews: 1
)
])
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"period" => "day",
"date" => "2021-01-01",
"property" => "event:page",
"with_imported" => "true",
"metrics" => "pageviews"
})
assert json_response(conn, 200) == %{
"results" => [
%{"page" => "/", "pageviews" => 2},
%{"page" => "/include-me", "pageviews" => 1},
%{"page" => "/plausible.io", "pageviews" => 1}
]
}
end
test "breakdown by event:page", %{conn: conn, site: site} do
populate_stats(site, [
build(:pageview, pathname: "/", timestamp: ~N[2021-01-01 00:00:00]),
build(:pageview, pathname: "/", timestamp: ~N[2021-01-01 00:25:00]),
build(:pageview,
pathname: "/plausible.io",
timestamp: ~N[2021-01-01 00:00:00]
)
])
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"period" => "day",
"date" => "2021-01-01",
"property" => "event:page"
})
assert json_response(conn, 200) == %{
"results" => [
%{"page" => "/", "visitors" => 2},
%{"page" => "/plausible.io", "visitors" => 1}
]
}
end
test "breakdown by event:page when there are no events in the second page", %{
conn: conn,
site: site
} do
populate_stats(site, [
build(:pageview, pathname: "/", timestamp: ~N[2021-01-01 00:00:00]),
build(:pageview, pathname: "/", timestamp: ~N[2021-01-01 00:25:00]),
build(:pageview,
pathname: "/plausible.io",
timestamp: ~N[2021-01-01 00:00:00]
)
])
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"period" => "day",
"date" => "2021-01-01",
"property" => "event:page",
"metrics" => "visitors,bounce_rate",
"page" => 2,
"limit" => 2
})
assert json_response(conn, 200) == %{"results" => []}
end
test "attempting to breakdown by event:hostname returns an error", %{conn: conn, site: site} do
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"period" => "day",
"date" => "2021-01-01",
"property" => "event:hostname",
"with_imported" => "true"
})
assert %{
"error" => error
} = json_response(conn, 400)
assert error =~ "Property 'event:hostname' is currently not supported for breakdowns."
end
describe "breakdown by visit:exit_page" do
setup %{site: site} do
site_import = insert(:site_import, site: site)
populate_stats(site, site_import.id, [
build(:pageview,
pathname: "/a",
timestamp: ~N[2021-01-01 00:00:00]
),
build(:pageview,
user_id: @user_id,
pathname: "/a",
timestamp: ~N[2021-01-01 00:25:00]
),
build(:pageview,
user_id: @user_id,
pathname: "/b",
timestamp: ~N[2021-01-01 00:35:00]
),
build(:imported_exit_pages,
exit_page: "/b",
exits: 3,
visitors: 2,
pageviews: 5,
date: ~D[2021-01-01]
)
])
end
test "can breakdown by visit:exit_page", %{conn: conn, site: site} do
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"period" => "day",
"date" => "2021-01-01",
"property" => "visit:exit_page",
"with_imported" => "true"
})
assert json_response(conn, 200) == %{
"results" => [
%{"exit_page" => "/b", "visitors" => 3},
%{"exit_page" => "/a", "visitors" => 1}
]
}
end
test "handles all applicable metrics with graceful fallback for imported data when needed", %{
conn: conn,
site: site
} do
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"period" => "day",
"date" => "2021-01-01",
"property" => "visit:exit_page",
"metrics" => "visitors,visits,bounce_rate,visit_duration,events,pageviews",
"with_imported" => "true"
})
assert json_response(conn, 200) == %{
"results" => [
%{
"bounce_rate" => 0.0,
"exit_page" => "/b",
"visit_duration" => 150.0,
"visitors" => 3,
"visits" => 4,
"events" => 7,
"pageviews" => 7
},
%{
"bounce_rate" => 100.0,
"exit_page" => "/a",
"visit_duration" => 0.0,
"visitors" => 1,
"visits" => 1,
"events" => 1,
"pageviews" => 1
}
]
}
end
end
describe "custom events" do
test "can breakdown by event:name", %{conn: conn, site: site} do
populate_stats(site, [
build(:event,
name: "Signup",
timestamp: ~N[2021-01-01 00:00:00]
),
build(:event,
name: "Signup",
timestamp: ~N[2021-01-01 00:00:00]
),
build(:pageview,
timestamp: ~N[2021-01-01 00:25:00]
)
])
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"period" => "day",
"date" => "2021-01-01",
"property" => "event:name"
})
assert json_response(conn, 200) == %{
"results" => [
%{"name" => "Signup", "visitors" => 2},
%{"name" => "pageview", "visitors" => 1}
]
}
end
test "can breakdown by event:name with visitors and events metrics", %{conn: conn, site: site} do
populate_stats(site, [
build(:pageview,
pathname: "/non-existing",
user_id: @user_id,
timestamp: ~N[2021-01-01 00:00:00]
),
build(:event,
name: "404",
pathname: "/non-existing",
user_id: @user_id,
timestamp: ~N[2021-01-01 00:00:00]
),
build(:pageview,
pathname: "/non-existing",
timestamp: ~N[2021-01-01 00:00:01]
),
build(:pageview,
pathname: "/non-existing",
user_id: @user_id,
timestamp: ~N[2021-01-01 00:00:02]
),
build(:event,
name: "404",
pathname: "/non-existing",
user_id: @user_id,
timestamp: ~N[2021-01-01 00:00:02]
),
build(:pageview,
pathname: "/non-existing",
user_id: @user_id,
timestamp: ~N[2021-01-01 00:00:03]
)
])
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"period" => "day",
"date" => "2021-01-01",
"property" => "event:name",
"metrics" => "visitors,events"
})
assert json_response(conn, 200) == %{
"results" => [
%{"name" => "pageview", "visitors" => 2, "events" => 4},
%{"name" => "404", "visitors" => 1, "events" => 2}
]
}
end
test "can breakdown by event:name while filtering for something", %{conn: conn, site: site} do
populate_stats(site, [
build(:event,
name: "Signup",
pathname: "/pageA",
browser: "Chrome",
timestamp: ~N[2021-01-01 00:00:00]
),
build(:event,
name: "Signup",
pathname: "/pageA",
browser: "Chrome",
timestamp: ~N[2021-01-01 00:00:00]
),
build(:event,
name: "Signup",
pathname: "/pageA",
browser: "Safari",
timestamp: ~N[2021-01-01 00:00:00]
),
build(:event,
name: "Signup",
pathname: "/pageB",
browser: "Chrome",
timestamp: ~N[2021-01-01 00:00:00]
),
build(:pageview,
pathname: "/pageA",
browser: "Chrome",
timestamp: ~N[2021-01-01 00:25:00]
)
])
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"period" => "day",
"date" => "2021-01-01",
"property" => "event:name",
"filters" => "event:page==/pageA;visit:browser==Chrome"
})
assert json_response(conn, 200) == %{
"results" => [
%{"name" => "Signup", "visitors" => 2},
%{"name" => "pageview", "visitors" => 1}
]
}
end
test "can breakdown by a visit:property when filtering by event:name", %{
conn: conn,
site: site
} do
populate_stats(site, [
build(:pageview,
referrer_source: "Google",
user_id: @user_id,
timestamp: ~N[2021-01-01 00:00:00]
),
build(:event,
name: "Signup",
user_id: @user_id,
timestamp: ~N[2021-01-01 00:00:00]
),
build(:pageview,
referrer_source: "Twitter",
timestamp: ~N[2021-01-01 00:25:00]
)
])
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"period" => "day",
"date" => "2021-01-01",
"property" => "visit:source",
"filters" => "event:name==Signup"
})
assert json_response(conn, 200) == %{
"results" => [
%{"source" => "Google", "visitors" => 1}
]
}
end
test "can breakdown by event:name when filtering by event:page", %{conn: conn, site: site} do
populate_stats(site, [
build(:pageview,
pathname: "/pageA",
timestamp: ~N[2021-01-01 00:00:00]
),
build(:pageview,
pathname: "/pageA",
timestamp: ~N[2021-01-01 00:00:00]
),
build(:event,
pathname: "/pageA",
name: "Signup",
timestamp: ~N[2021-01-01 00:00:00]
),
build(:pageview,
pathname: "/pageB",
referrer_source: "Twitter",
timestamp: ~N[2021-01-01 00:25:00]
)
])
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"period" => "day",
"date" => "2021-01-01",
"property" => "event:name",
"filters" => "event:page==/pageA"
})
assert json_response(conn, 200) == %{
"results" => [
%{"name" => "pageview", "visitors" => 2},
%{"name" => "Signup", "visitors" => 1}
]
}
end
test "can breakdown by event:page when filtering by event:name", %{conn: conn, site: site} do
populate_stats(site, [
build(:event,
name: "Signup",
pathname: "/pageA",
timestamp: ~N[2021-01-01 00:00:00]
),
build(:event,
name: "Signup",
pathname: "/pageA",
timestamp: ~N[2021-01-01 00:00:00]
),
build(:event,
name: "Signup",
pathname: "/pageB",
timestamp: ~N[2021-01-01 00:00:00]
),
build(:pageview,
pathname: "/pageB",
referrer_source: "Twitter",
timestamp: ~N[2021-01-01 00:25:00]
)
])
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"period" => "day",
"date" => "2021-01-01",
"property" => "event:page",
"filters" => "event:name==Signup"
})
assert json_response(conn, 200) == %{
"results" => [
%{"page" => "/pageA", "visitors" => 2},
%{"page" => "/pageB", "visitors" => 1}
]
}
end
test "can filter event:page with a wildcard", %{
conn: conn,
site: site
} do
populate_stats(site, [
build(:pageview, pathname: "/en/page1"),
build(:pageview, pathname: "/en/page2"),
build(:pageview, pathname: "/en/page2"),
build(:pageview, pathname: "/pl/page1")
])
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"period" => "day",
"property" => "event:page",
"filters" => "event:page==/en/**"
})
assert json_response(conn, 200) == %{
"results" => [
%{"page" => "/en/page2", "visitors" => 2},
%{"page" => "/en/page1", "visitors" => 1}
]
}
end
test "can filter event:hostname with a wildcard", %{
conn: conn,
site: site
} do
populate_stats(site, [
build(:pageview, hostname: "alice.example.com", pathname: "/a"),
build(:pageview, hostname: "anna.example.com", pathname: "/a"),
build(:pageview, hostname: "adam.example.com", pathname: "/a"),
build(:pageview, hostname: "bob.example.com", pathname: "/b")
])
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"period" => "day",
"property" => "event:page",
"filters" => "event:hostname==a*.example.com"
})
assert json_response(conn, 200) == %{
"results" => [
%{"page" => "/a", "visitors" => 3}
]
}
end
test "breakdown by custom event property", %{conn: conn, site: site} do
populate_stats(site, [
build(:event,
name: "Purchase",
"meta.key": ["package"],
"meta.value": ["business"],
timestamp: ~N[2021-01-01 00:00:00]
),
build(:event,
name: "Purchase",
"meta.key": ["package"],
"meta.value": ["personal"],
timestamp: ~N[2021-01-01 00:00:00]
),
build(:event,
name: "Purchase",
"meta.key": ["package"],
"meta.value": ["business"],
timestamp: ~N[2021-01-01 00:25:00]
),
build(:event,
name: "Some other event",
"meta.key": ["package"],
"meta.value": ["business"],
timestamp: ~N[2021-01-01 00:25:00]
)
])
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"period" => "day",
"date" => "2021-01-01",
"property" => "event:props:package",
"filters" => "event:name==Purchase"
})
assert json_response(conn, 200) == %{
"results" => [
%{"package" => "business", "visitors" => 2},
%{"package" => "personal", "visitors" => 1}
]
}
end
test "breakdown by custom event property, with pageviews metric", %{conn: conn, site: site} do
populate_stats(site, [
build(:pageview,
"meta.key": ["package"],
"meta.value": ["business"],
timestamp: ~N[2021-01-01 00:00:00]
),
build(:pageview,
"meta.key": ["package"],
"meta.value": ["personal"],
timestamp: ~N[2021-01-01 00:00:00]
),
build(:pageview,
"meta.key": ["package"],
"meta.value": ["business"],
timestamp: ~N[2021-01-01 00:25:00]
)
])
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"period" => "day",
"date" => "2021-01-01",
"property" => "event:props:package",
"metrics" => "pageviews"
})
assert json_response(conn, 200) == %{
"results" => [
%{"package" => "business", "pageviews" => 2},
%{"package" => "personal", "pageviews" => 1}
]
}
end
test "breakdown by custom event property, with (none)", %{conn: conn, site: site} do
populate_stats(site, [
build(:event,
name: "Purchase",
"meta.key": ["cost"],
"meta.value": ["16"],
timestamp: ~N[2021-01-01 00:00:00]
),
build(:event,
name: "Purchase",
"meta.key": ["cost"],
"meta.value": ["16"],
timestamp: ~N[2021-01-01 00:00:00]
),
build(:event,
name: "Purchase",
"meta.key": ["cost"],
"meta.value": ["16"],
timestamp: ~N[2021-01-01 00:00:00]
),
build(:event,
name: "Purchase",
timestamp: ~N[2021-01-01 00:25:00]
),
build(:event,
name: "Purchase",
"meta.key": ["cost"],
"meta.value": ["14"],
timestamp: ~N[2021-01-01 00:25:00]
),
build(:event,
name: "Purchase",
"meta.key": ["cost"],
"meta.value": ["14"],
timestamp: ~N[2021-01-01 00:26:00]
)
])
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"period" => "day",
"date" => "2021-01-01",
"property" => "event:props:cost",
"filters" => "event:name==Purchase"
})
assert json_response(conn, 200) == %{
"results" => [
%{"cost" => "16", "visitors" => 3},
%{"cost" => "14", "visitors" => 2},
%{"cost" => "(none)", "visitors" => 1}
]
}
end
test "breakdown by custom event property, limited", %{conn: conn, site: site} do
populate_stats(site, [
build(:event,
name: "Purchase",
"meta.key": ["cost"],
"meta.value": ["16"],
timestamp: ~N[2021-01-01 00:00:00]
),
build(:event,
name: "Purchase",
"meta.key": ["cost"],
"meta.value": ["18"],
timestamp: ~N[2021-01-01 00:25:00]
),
build(:event,
name: "Purchase",
"meta.key": ["cost"],
"meta.value": ["14"],
timestamp: ~N[2021-01-01 00:25:00]
),
build(:event,
name: "Purchase",
"meta.key": ["cost"],
"meta.value": ["14"],
timestamp: ~N[2021-01-01 00:26:00]
)
])
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"period" => "day",
"date" => "2021-01-01",
"property" => "event:props:cost",
"filters" => "event:name==Purchase",
"limit" => 2
})
assert json_response(conn, 200) == %{
"results" => [
%{"cost" => "14", "visitors" => 2},
%{"cost" => "16", "visitors" => 1}
]
}
end
test "breakdown by custom event property, paginated", %{conn: conn, site: site} do
populate_stats(site, [
build(:event,
name: "Purchase",
"meta.key": ["cost"],
"meta.value": ["16"],
timestamp: ~N[2021-01-01 00:00:00]
),
build(:event,
name: "Purchase",
"meta.key": ["cost"],
"meta.value": ["16"],
timestamp: ~N[2021-01-01 00:00:00]
),
build(:event,
name: "Purchase",
"meta.key": ["cost"],
"meta.value": ["18"],
timestamp: ~N[2021-01-01 00:25:00]
),
build(:event,
name: "Purchase",
"meta.key": ["cost"],
"meta.value": ["14"],
timestamp: ~N[2021-01-01 00:25:00]
),
build(:event,
name: "Purchase",
"meta.key": ["cost"],
"meta.value": ["14"],
timestamp: ~N[2021-01-01 00:26:00]
)
])
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"period" => "day",
"date" => "2021-01-01",
"property" => "event:props:cost",
"filters" => "event:name==Purchase",
"limit" => 2,
"page" => 2
})
assert json_response(conn, 200) == %{
"results" => [
%{"cost" => "18", "visitors" => 1}
]
}
end
end
describe "breakdown by event:goal" do
test "returns custom event goals and pageview goals", %{conn: conn, site: site} do
insert(:goal, %{site: site, event_name: "Purchase"})
insert(:goal, %{site: site, page_path: "/test"})
populate_stats(site, [
build(:pageview,
timestamp: ~N[2021-01-01 00:00:01],
pathname: "/test"
),
build(:event,
name: "Purchase",
timestamp: ~N[2021-01-01 00:00:03]
),
build(:event,
name: "Purchase",
timestamp: ~N[2021-01-01 00:00:03]
)
])
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"period" => "day",
"date" => "2021-01-01",
"property" => "event:goal"
})
assert [
%{"goal" => "Purchase", "visitors" => 2},
%{"goal" => "Visit /test", "visitors" => 1}
] = json_response(conn, 200)["results"]
end
test "returns pageview goals containing wildcards", %{conn: conn, site: site} do
insert(:goal, %{site: site, page_path: "/**/post"})
insert(:goal, %{site: site, page_path: "/blog**"})
populate_stats(site, [
build(:pageview, pathname: "/blog", user_id: @user_id),
build(:pageview, pathname: "/blog/post-1", user_id: @user_id),
build(:pageview, pathname: "/blog/post-2", user_id: @user_id),
build(:pageview, pathname: "/blog/something/post"),
build(:pageview, pathname: "/different/page/post")
])
conn =
get(conn, "/api/v1/stats/breakdown?period=day", %{
"site_id" => site.domain,
"metrics" => "visitors,pageviews",
"property" => "event:goal"
})
assert [
%{"goal" => "Visit /**/post", "visitors" => 2, "pageviews" => 2},
%{"goal" => "Visit /blog**", "visitors" => 2, "pageviews" => 4}
] = json_response(conn, 200)["results"]
end
test "does not return goals that are not configured for the site", %{conn: conn, site: site} do
populate_stats(site, [
build(:pageview, pathname: "/register"),
build(:event, name: "Signup")
])
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"metrics" => "visitors,pageviews",
"property" => "event:goal"
})
assert [] = json_response(conn, 200)["results"]
end
end
describe "filtering" do
test "event:goal filter returns 400 when goal not configured", %{conn: conn, site: site} do
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"property" => "event:page",
"filters" => "event:goal==Register"
})
assert %{"error" => msg} = json_response(conn, 400)
assert msg =~ "The goal `Register` is not configured for this site. Find out how"
end
test "validates that filters are valid", %{conn: conn, site: site} do
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"property" => "event:page",
"filters" => "badproperty==bar"
})
assert json_response(conn, 400) == %{
"error" =>
"Invalid filter property 'badproperty'. Please provide a valid filter property: https://plausible.io/docs/stats-api#properties"
}
end
test "event:page filter for breakdown by session props", %{conn: conn, site: site} do
populate_stats(site, [
build(:pageview,
pathname: "/ignore",
browser: "Chrome",
timestamp: ~N[2021-01-01 00:00:00]
),
build(:pageview,
pathname: "/plausible.io",
browser: "Chrome",
timestamp: ~N[2021-01-01 00:00:00]
),
build(:pageview,
pathname: "/plausible.io",
browser: "Chrome",
timestamp: ~N[2021-01-01 00:25:00]
),
build(:pageview,
browser: "Safari",
pathname: "/plausible.io",
timestamp: ~N[2021-01-01 00:00:00]
)
])
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"period" => "day",
"date" => "2021-01-01",
"property" => "visit:browser",
"filters" => "event:page==/plausible.io"
})
assert json_response(conn, 200) == %{
"results" => [
%{"browser" => "Chrome", "visitors" => 2},
%{"browser" => "Safari", "visitors" => 1}
]
}
end
test "event:page filter shows sources of sessions that have visited that page", %{
conn: conn,
site: site
} do
populate_stats(site, [
build(:pageview,
pathname: "/",
referrer_source: "Twitter",
utm_medium: "Twitter",
utm_source: "Twitter",
utm_campaign: "Twitter",
user_id: @user_id
),
build(:pageview,
pathname: "/plausible.io",
user_id: @user_id
),
build(:pageview,
pathname: "/plausible.io",
referrer_source: "Google",
utm_medium: "Google",
utm_source: "Google",
utm_campaign: "Google"
),
build(:pageview,
pathname: "/plausible.io",
referrer_source: "Google",
utm_medium: "Google",
utm_source: "Google",
utm_campaign: "Google"
)
])
for property <- ["source", "utm_medium", "utm_source", "utm_campaign"] do
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"period" => "day",
"property" => "visit:" <> property,
"filters" => "event:page==/plausible.io"
})
assert json_response(conn, 200) == %{
"results" => [
%{property => "Google", "visitors" => 2},
%{property => "Twitter", "visitors" => 1}
]
}
end
end
test "top sources for a custom goal and filtered by hostname", %{conn: conn, site: site} do
populate_stats(site, [
build(:pageview,
hostname: "blog.example.com",
referrer_source: "Facebook",
user_id: @user_id
),
build(:pageview,
hostname: "app.example.com",
pathname: "/register",
user_id: @user_id
),
build(:event,
name: "Signup",
hostname: "app.example.com",
pathname: "/register",
user_id: @user_id
)
])
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"period" => "day",
"property" => "visit:source",
"filters" => "event:hostname==app.example.com"
})
assert json_response(conn, 200) == %{"results" => []}
end
test "top sources for a custom goal and filtered by hostname (2)", %{conn: conn, site: site} do
populate_stats(site, [
build(:pageview,
hostname: "app.example.com",
referrer_source: "Facebook",
pathname: "/register",
user_id: @user_id
),
build(:event,
name: "Signup",
hostname: "app.example.com",
pathname: "/register",
user_id: @user_id
)
])
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"period" => "day",
"property" => "visit:source",
"filters" => "event:hostname==app.example.com"
})
assert json_response(conn, 200) == %{
"results" => [%{"source" => "Facebook", "visitors" => 1}]
}
end
test "event:page filter is interpreted as entry_page filter only for bounce_rate", %{
conn: conn,
site: site
} do
populate_stats(site, [
build(:pageview,
browser: "Chrome",
user_id: @user_id,
pathname: "/ignore",
timestamp: ~N[2021-01-01 00:00:00]
),
build(:pageview,
browser: "Chrome",
user_id: @user_id,
pathname: "/plausible.io",
timestamp: ~N[2021-01-01 00:01:00]
),
build(:pageview,
browser: "Chrome",
user_id: 456,
pathname: "/important-page",
timestamp: ~N[2021-01-01 00:00:00]
),
build(:pageview,
browser: "Chrome",
user_id: 456,
pathname: "/",
timestamp: ~N[2021-01-01 00:01:00]
),
build(:pageview,
browser: "Chrome",
pathname: "/plausible.io",
timestamp: ~N[2021-01-01 00:01:00]
)
])
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"period" => "day",
"date" => "2021-01-01",
"metrics" => "visitors,bounce_rate",
"property" => "visit:browser",
"filters" => "event:page == /plausible.io|/important-page"
})
assert json_response(conn, 200) == %{
"results" => [
%{
"browser" => "Chrome",
"bounce_rate" => 50,
"visitors" => 3
}
]
}
end
test "event:goal pageview filter for breakdown by visit source", %{conn: conn, site: site} do
insert(:goal, %{site: site, page_path: "/plausible.io"})
populate_stats(site, [
build(:pageview,
referrer_source: "Bing",
timestamp: ~N[2021-01-01 00:00:00]
),
build(:pageview,
referrer_source: "Google",
user_id: @user_id,
timestamp: ~N[2021-01-01 00:00:00]
),
build(:pageview,
pathname: "/plausible.io",
user_id: @user_id,
timestamp: ~N[2021-01-01 00:00:00]
)
])
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"period" => "day",
"date" => "2021-01-01",
"property" => "visit:source",
"filters" => "event:goal == Visit /plausible.io"
})
assert json_response(conn, 200) == %{
"results" => [
%{"source" => "Google", "visitors" => 1}
]
}
end
test "event:goal custom event filter for breakdown by visit source", %{conn: conn, site: site} do
insert(:goal, %{site: site, event_name: "Register"})
populate_stats(site, [
build(:pageview,
referrer_source: "Bing",
timestamp: ~N[2021-01-01 00:00:00]
),
build(:pageview,
referrer_source: "Google",
user_id: @user_id,
timestamp: ~N[2021-01-01 00:00:00]
),
build(:event,
name: "Register",
user_id: @user_id,
timestamp: ~N[2021-01-01 00:00:00]
)
])
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"period" => "day",
"date" => "2021-01-01",
"property" => "visit:source",
"filters" => "event:goal == Register"
})
assert json_response(conn, 200) == %{
"results" => [
%{"source" => "Google", "visitors" => 1}
]
}
end
test "wildcard pageview goal filter for breakdown by event:page", %{conn: conn, site: site} do
populate_stats(site, [
build(:pageview, pathname: "/en/register"),
build(:pageview, pathname: "/en/register", user_id: @user_id),
build(:pageview, pathname: "/en/register", user_id: @user_id),
build(:pageview, pathname: "/123/it/register"),
build(:pageview, pathname: "/should-not-appear")
])
insert(:goal, %{site: site, page_path: "/**register"})
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"period" => "day",
"metrics" => "visitors,pageviews",
"property" => "event:page",
"filters" => "event:goal==Visit /**register"
})
assert json_response(conn, 200) == %{
"results" => [
%{"page" => "/en/register", "visitors" => 2, "pageviews" => 3},
%{"page" => "/123/it/register", "visitors" => 1, "pageviews" => 1}
]
}
end
test "mixed multi-goal filter for breakdown by visit:country", %{conn: conn, site: site} do
populate_stats(site, [
build(:pageview, country_code: "EE", pathname: "/en/register"),
build(:event, country_code: "EE", name: "Signup", pathname: "/en/register"),
build(:pageview, country_code: "US", pathname: "/123/it/register"),
build(:pageview, country_code: "US", pathname: "/different")
])
insert(:goal, %{site: site, page_path: "/**register"})
insert(:goal, %{site: site, event_name: "Signup"})
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"period" => "day",
"metrics" => "visitors,pageviews,events",
"property" => "visit:country",
"filters" => "event:goal==Signup|Visit /**register"
})
assert json_response(conn, 200) == %{
"results" => [
%{"country" => "EE", "visitors" => 2, "pageviews" => 1, "events" => 2},
%{"country" => "US", "visitors" => 1, "pageviews" => 1, "events" => 1}
]
}
end
test "event:goal custom event filter for breakdown by event page", %{conn: conn, site: site} do
insert(:goal, %{site: site, event_name: "Register"})
populate_stats(site, [
build(:event,
pathname: "/en/register",
name: "Register"
),
build(:event,
pathname: "/en/register",
name: "Register"
),
build(:event,
pathname: "/it/register",
name: "Register"
)
])
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"period" => "day",
"property" => "event:page",
"filters" => "event:goal == Register"
})
assert json_response(conn, 200) == %{
"results" => [
%{"page" => "/en/register", "visitors" => 2},
%{"page" => "/it/register", "visitors" => 1}
]
}
end
test "IN filter for event:page", %{conn: conn, site: site} do
populate_stats(site, [
build(:pageview,
pathname: "/ignore",
timestamp: ~N[2021-01-01 00:00:00]
),
build(:pageview,
pathname: "/plausible.io",
timestamp: ~N[2021-01-01 00:00:00]
),
build(:pageview,
pathname: "/plausible.io",
timestamp: ~N[2021-01-01 00:00:00]
),
build(:pageview,
pathname: "/important-page",
timestamp: ~N[2021-01-01 00:00:00]
)
])
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"period" => "day",
"date" => "2021-01-01",
"property" => "event:page",
"filters" => "event:page == /plausible.io|/important-page"
})
assert json_response(conn, 200) == %{
"results" => [
%{"page" => "/plausible.io", "visitors" => 2},
%{"page" => "/important-page", "visitors" => 1}
]
}
end
test "IN filter for visit:browser", %{conn: conn, site: site} do
populate_stats(site, [
build(:pageview,
pathname: "/ignore",
browser: "Firefox",
timestamp: ~N[2021-01-01 00:00:00]
),
build(:pageview,
pathname: "/plausible.io",
browser: "Chrome",
timestamp: ~N[2021-01-01 00:00:00]
),
build(:pageview,
pathname: "/plausible.io",
browser: "Safari",
timestamp: ~N[2021-01-01 00:00:00]
),
build(:pageview,
pathname: "/important-page",
browser: "Safari",
timestamp: ~N[2021-01-01 00:00:00]
)
])
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"period" => "day",
"date" => "2021-01-01",
"property" => "event:page",
"filters" => "visit:browser == Chrome|Safari"
})
assert json_response(conn, 200) == %{
"results" => [
%{"page" => "/plausible.io", "visitors" => 2},
%{"page" => "/important-page", "visitors" => 1}
]
}
end
test "IN filter for visit:entry_page", %{conn: conn, site: site} do
populate_stats(site, [
build(:pageview,
pathname: "/ignore",
timestamp: ~N[2021-01-01 00:00:00]
),
build(:pageview,
pathname: "/plausible.io",
timestamp: ~N[2021-01-01 00:00:00]
),
build(:pageview,
pathname: "/plausible.io",
timestamp: ~N[2021-01-01 00:00:00]
),
build(:pageview,
pathname: "/important-page",
timestamp: ~N[2021-01-01 00:00:00]
)
])
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"period" => "day",
"date" => "2021-01-01",
"property" => "event:page",
"filters" => "event:page == /plausible.io|/important-page",
"metrics" => "bounce_rate"
})
assert json_response(conn, 200) == %{
"results" => [
%{"page" => "/important-page", "bounce_rate" => 100},
%{"page" => "/plausible.io", "bounce_rate" => 100}
]
}
end
test "IN filter for event:name", %{conn: conn, site: site} do
populate_stats(site, [
build(:event,
name: "Signup",
timestamp: ~N[2021-01-01 00:00:00]
),
build(:event,
name: "Signup",
timestamp: ~N[2021-01-01 00:00:00]
),
build(:event,
name: "Login",
timestamp: ~N[2021-01-01 00:00:00]
),
build(:event,
name: "Irrelevant",
timestamp: ~N[2021-01-01 00:00:00]
)
])
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"period" => "day",
"date" => "2021-01-01",
"property" => "event:name",
"filters" => "event:name == Signup|Login"
})
assert json_response(conn, 200) == %{
"results" => [
%{"name" => "Signup", "visitors" => 2},
%{"name" => "Login", "visitors" => 1}
]
}
end
test "IN filter for event:props:*", %{conn: conn, site: site} do
populate_stats(site, [
build(:pageview,
browser: "Chrome",
"meta.key": ["browser"],
"meta.value": ["Chrome"],
timestamp: ~N[2021-01-01 00:00:00]
),
build(:pageview,
browser: "Chrome",
"meta.key": ["browser"],
"meta.value": ["Chrome"],
timestamp: ~N[2021-01-01 00:00:00]
),
build(:pageview,
browser: "Safari",
"meta.key": ["browser"],
"meta.value": ["Safari"],
timestamp: ~N[2021-01-01 00:00:00]
),
build(:pageview,
browser: "Firefox",
"meta.key": ["browser"],
"meta.value": ["Firefox"],
timestamp: ~N[2021-01-01 00:00:00]
)
])
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"period" => "day",
"date" => "2021-01-01",
"property" => "visit:browser",
"filters" => "event:props:browser == Chrome|Safari"
})
assert json_response(conn, 200) == %{
"results" => [
%{"browser" => "Chrome", "visitors" => 2},
%{"browser" => "Safari", "visitors" => 1}
]
}
end
test "Multiple event:props:* filters", %{conn: conn, site: site} do
populate_stats(site, [
build(:pageview,
browser: "Chrome",
"meta.key": ["browser"],
"meta.value": ["Chrome"],
timestamp: ~N[2021-01-01 00:00:00]
),
build(:pageview,
browser: "Chrome",
"meta.key": ["browser", "prop"],
"meta.value": ["Chrome", "xyz"],
timestamp: ~N[2021-01-01 00:00:00]
),
build(:pageview,
browser: "Safari",
"meta.key": ["browser", "prop"],
"meta.value": ["Safari", "target_value"],
timestamp: ~N[2021-01-01 00:00:00]
),
build(:pageview,
browser: "Firefox",
"meta.key": ["browser", "prop"],
"meta.value": ["Firefox", "target_value"],
timestamp: ~N[2021-01-01 00:00:00]
)
])
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"period" => "day",
"date" => "2021-01-01",
"property" => "visit:browser",
"filters" => "event:props:browser == Chrome|Safari;event:props:prop == target_value"
})
assert json_response(conn, 200) == %{
"results" => [
%{"browser" => "Safari", "visitors" => 1}
]
}
end
test "IN filter for event:props:* including (none) value", %{conn: conn, site: site} do
populate_stats(site, [
build(:pageview,
browser: "Chrome",
"meta.key": ["browser"],
"meta.value": ["Chrome"],
timestamp: ~N[2021-01-01 00:00:00]
),
build(:pageview,
browser: "Chrome",
"meta.key": ["browser"],
"meta.value": ["Chrome"],
timestamp: ~N[2021-01-01 00:00:00]
),
build(:pageview,
browser: "Safari",
timestamp: ~N[2021-01-01 00:00:00]
),
build(:pageview,
browser: "Firefox",
"meta.key": ["browser"],
"meta.value": ["Firefox"],
timestamp: ~N[2021-01-01 00:00:00]
)
])
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"period" => "day",
"date" => "2021-01-01",
"property" => "visit:browser",
"filters" => "event:props:browser == Chrome|(none)"
})
assert json_response(conn, 200) == %{
"results" => [
%{"browser" => "Chrome", "visitors" => 2},
%{"browser" => "Safari", "visitors" => 1}
]
}
end
test "can use a is_not filter", %{conn: conn, site: site} do
populate_stats(site, [
build(:pageview, browser: "Chrome"),
build(:pageview, browser: "Safari"),
build(:pageview, browser: "Safari"),
build(:pageview, browser: "Edge")
])
conn =
get(conn, "/api/v1/stats/breakdown?period=day", %{
"site_id" => site.domain,
"filters" => "visit:browser != Chrome",
"property" => "visit:browser"
})
assert json_response(conn, 200) == %{
"results" => [
%{"browser" => "Safari", "visitors" => 2},
%{"browser" => "Edge", "visitors" => 1}
]
}
end
end
describe "pagination" do
test "can limit results", %{conn: conn, site: site} do
populate_stats(site, [
build(:pageview, pathname: "/a", timestamp: ~N[2021-01-01 00:00:00]),
build(:pageview, pathname: "/b", timestamp: ~N[2021-01-01 00:25:00]),
build(:pageview, pathname: "/c", timestamp: ~N[2021-01-01 00:00:00])
])
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"period" => "day",
"date" => "2021-01-01",
"property" => "event:page",
"limit" => 2
})
res = json_response(conn, 200)
assert Enum.count(res["results"]) == 2
end
test "does not repeat results", %{conn: conn, site: site} do
populate_stats(site, [
build(:pageview, %{"meta.key": ["item"], "meta.value": ["apple"]}),
build(:pageview, %{"meta.key": ["item"], "meta.value": ["kiwi"]}),
build(:pageview, %{"meta.key": ["item"], "meta.value": ["pineapple"]}),
build(:pageview, %{"meta.key": ["item"], "meta.value": ["grapes"]})
])
params = %{
"site_id" => site.domain,
"metrics" => "visitors",
"property" => "event:props:item",
"limit" => 3,
"page" => nil
}
first_page =
conn
|> get("/api/v1/stats/breakdown", %{params | "page" => 1})
|> json_response(200)
|> Map.get("results")
|> Enum.map(& &1["item"])
|> MapSet.new()
second_page =
conn
|> get("/api/v1/stats/breakdown", %{params | "page" => 2})
|> json_response(200)
|> Map.get("results")
|> Enum.map(& &1["item"])
|> MapSet.new()
assert first_page |> MapSet.intersection(second_page) |> Enum.empty?()
end
@invalid_limit_message "Please provide limit as a number between 1 and 1000."
test "returns error when limit too large", %{conn: conn, site: site} do
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"property" => "event:page",
"limit" => 1001
})
assert json_response(conn, 400) == %{"error" => @invalid_limit_message}
end
test "returns error with non-integer limit", %{conn: conn, site: site} do
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"property" => "event:page",
"limit" => "bad_limit"
})
assert json_response(conn, 400) == %{"error" => @invalid_limit_message}
end
test "returns error with negative integer limit", %{conn: conn, site: site} do
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"property" => "event:page",
"limit" => -1
})
assert json_response(conn, 400) == %{"error" => @invalid_limit_message}
end
@invalid_page_message "Please provide page as a number greater than 0."
test "returns error with non-integer page", %{conn: conn, site: site} do
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"property" => "event:page",
"page" => "bad_page"
})
assert json_response(conn, 400) == %{"error" => @invalid_page_message}
end
test "returns error with negative integer page", %{conn: conn, site: site} do
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"property" => "event:page",
"page" => -1
})
assert json_response(conn, 400) == %{"error" => @invalid_page_message}
end
test "returns error with zero page", %{conn: conn, site: site} do
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"property" => "event:page",
"page" => 0
})
assert json_response(conn, 400) == %{"error" => @invalid_page_message}
end
test "can paginate results", %{conn: conn, site: site} do
populate_stats(site, [
build(:pageview, pathname: "/a", timestamp: ~N[2021-01-01 00:00:00]),
build(:pageview, pathname: "/b", timestamp: ~N[2021-01-01 00:25:00]),
build(:pageview, pathname: "/c", timestamp: ~N[2021-01-01 00:00:00])
])
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"period" => "day",
"date" => "2021-01-01",
"property" => "event:page",
"limit" => 2,
"page" => 2
})
res = json_response(conn, 200)
assert Enum.count(res["results"]) == 1
end
end
describe "metrics" do
test "returns time_on_page with imported data", %{conn: conn, site: site} do
site_import =
insert(:site_import,
site: site,
start_date: ~D[2005-01-01],
end_date: Date.utc_today(),
source: :universal_analytics
)
populate_stats(site, site_import.id, [
build(:imported_pages, page: "/A", total_time_on_page: 40, date: ~D[2021-01-01]),
build(:imported_pages, page: "/A", total_time_on_page: 110, date: ~D[2021-01-01]),
build(:imported_pages, page: "/B", total_time_on_page: 499, date: ~D[2021-01-01]),
build(:pageview, pathname: "/A", user_id: 4, timestamp: ~N[2021-01-01 00:00:00]),
build(:engagement,
pathname: "/A",
user_id: 4,
timestamp: ~N[2021-01-01 00:01:00],
engagement_time: 60_000
),
build(:pageview, pathname: "/B", user_id: 4, timestamp: ~N[2021-01-01 00:01:00]),
build(:engagement,
pathname: "/B",
user_id: 4,
timestamp: ~N[2021-01-01 00:01:10],
engagement_time: 5_000
)
])
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"period" => "day",
"date" => "2021-01-01",
"property" => "event:page",
"metrics" => "visitors,time_on_page",
"with_imported" => "true"
})
assert json_response(conn, 200) == %{
"results" => [
%{
"page" => "/A",
"visitors" => 3,
"time_on_page" => 70
},
%{
"page" => "/B",
"visitors" => 2,
"time_on_page" => 252
}
]
}
end
test "returns time_on_page in an event:page breakdown", %{conn: conn, site: site} do
populate_stats(site, [
build(:pageview, pathname: "/A", timestamp: ~N[2021-01-01 00:00:00]),
build(:pageview, pathname: "/A", timestamp: ~N[2021-01-01 00:00:00]),
build(:pageview, pathname: "/B", timestamp: ~N[2021-01-01 00:00:00]),
build(:pageview, pathname: "/A", user_id: 4, timestamp: ~N[2021-01-01 00:00:00]),
build(:engagement,
pathname: "/A",
user_id: 4,
timestamp: ~N[2021-01-01 00:01:00],
engagement_time: 60_000
),
build(:pageview, pathname: "/B", user_id: 4, timestamp: ~N[2021-01-01 00:01:00]),
build(:engagement,
pathname: "/B",
user_id: 4,
timestamp: ~N[2021-01-01 00:02:30],
engagement_time: 90_000
),
build(:pageview, pathname: "/C", user_id: 4, timestamp: ~N[2021-01-01 00:02:30]),
build(:engagement,
pathname: "/C",
user_id: 4,
timestamp: ~N[2021-01-01 00:02:30],
engagement_time: 3_000
)
])
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"period" => "day",
"date" => "2021-01-01",
"property" => "event:page",
"metrics" => "visitors,time_on_page"
})
assert json_response(conn, 200) == %{
"results" => [
%{
"page" => "/A",
"visitors" => 3,
"time_on_page" => 60
},
%{
"page" => "/B",
"visitors" => 2,
"time_on_page" => 90
},
%{
"page" => "/C",
"visitors" => 1,
"time_on_page" => 3
}
]
}
end
test "returns time_on_page as the only metric in an event:page breakdown", %{
conn: conn,
site: site
} do
populate_stats(site, [
build(:pageview, pathname: "/A", timestamp: ~N[2021-01-01 00:00:00]),
build(:pageview, pathname: "/A", timestamp: ~N[2021-01-01 00:00:00]),
build(:pageview, pathname: "/B", timestamp: ~N[2021-01-01 00:00:00]),
build(:pageview, pathname: "/A", user_id: 4, timestamp: ~N[2021-01-01 00:00:00]),
build(:engagement,
pathname: "/A",
user_id: 4,
timestamp: ~N[2021-01-01 00:01:00],
engagement_time: 60_000
),
build(:pageview, pathname: "/B", user_id: 4, timestamp: ~N[2021-01-01 00:01:00]),
build(:engagement,
pathname: "/B",
user_id: 4,
timestamp: ~N[2021-01-01 00:02:30],
engagement_time: 90_000
),
build(:pageview, pathname: "/C", user_id: 4, timestamp: ~N[2021-01-01 00:02:30]),
build(:engagement,
pathname: "/C",
user_id: 4,
timestamp: ~N[2021-01-01 00:02:30],
engagement_time: 3_000
)
])
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"period" => "day",
"date" => "2021-01-01",
"property" => "event:page",
"metrics" => "time_on_page"
})
assert json_response(conn, 200) == %{
"results" => [
%{
"page" => "/A",
"time_on_page" => 60
},
%{
"page" => "/B",
"time_on_page" => 90
},
%{
"page" => "/C",
"time_on_page" => 3
}
]
}
end
test "returns conversion_rate in an event:goal breakdown", %{conn: conn, site: site} do
populate_stats(site, [
build(:event, name: "Signup", user_id: 1),
build(:event, name: "Signup", user_id: 1),
build(:pageview, pathname: "/blog"),
build(:pageview, pathname: "/blog/post"),
build(:pageview)
])
insert(:goal, %{site: site, event_name: "Signup"})
insert(:goal, %{site: site, page_path: "/blog**"})
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"period" => "day",
"property" => "event:goal",
"metrics" => "visitors,events,conversion_rate"
})
assert json_response(conn, 200) == %{
"results" => [
%{
"goal" => "Visit /blog**",
"visitors" => 2,
"events" => 2,
"conversion_rate" => 50
},
%{
"goal" => "Signup",
"visitors" => 1,
"events" => 2,
"conversion_rate" => 25
}
]
}
end
test "returns conversion_rate alone in an event:goal breakdown", %{conn: conn, site: site} do
populate_stats(site, [
build(:event, name: "Signup", user_id: 1),
build(:pageview)
])
insert(:goal, %{site: site, event_name: "Signup"})
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"period" => "day",
"property" => "event:goal",
"metrics" => "conversion_rate"
})
assert json_response(conn, 200) == %{
"results" => [
%{
"goal" => "Signup",
"conversion_rate" => 50
}
]
}
end
test "returns conversion_rate in a goal filtered custom prop breakdown", %{
conn: conn,
site: site
} do
populate_stats(site, [
build(:pageview, pathname: "/blog/1", "meta.key": ["author"], "meta.value": ["Uku"]),
build(:pageview, pathname: "/blog/2", "meta.key": ["author"], "meta.value": ["Uku"]),
build(:pageview, pathname: "/blog/3", "meta.key": ["author"], "meta.value": ["Uku"]),
build(:pageview, pathname: "/blog/1", "meta.key": ["author"], "meta.value": ["Marko"]),
build(:pageview,
pathname: "/blog/2",
"meta.key": ["author"],
"meta.value": ["Marko"],
user_id: 1
),
build(:pageview,
pathname: "/blog/3",
"meta.key": ["author"],
"meta.value": ["Marko"],
user_id: 1
),
build(:pageview, pathname: "/blog"),
build(:pageview, "meta.key": ["author"], "meta.value": ["Marko"]),
build(:pageview)
])
insert(:goal, %{site: site, page_path: "/blog**"})
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"period" => "day",
"property" => "event:props:author",
"filters" => "event:goal==Visit /blog**",
"metrics" => "visitors,events,conversion_rate"
})
assert json_response(conn, 200) == %{
"results" => [
%{
"author" => "Uku",
"visitors" => 3,
"events" => 3,
"conversion_rate" => 37.5
},
%{
"author" => "Marko",
"visitors" => 2,
"events" => 3,
"conversion_rate" => 25
},
%{
"author" => "(none)",
"visitors" => 1,
"events" => 1,
"conversion_rate" => 12.5
}
]
}
end
test "returns conversion_rate alone in a goal filtered custom prop breakdown", %{
conn: conn,
site: site
} do
populate_stats(site, [
build(:pageview, pathname: "/blog/1", "meta.key": ["author"], "meta.value": ["Uku"]),
build(:pageview)
])
insert(:goal, %{site: site, page_path: "/blog**"})
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"period" => "day",
"property" => "event:props:author",
"filters" => "event:goal==Visit /blog**",
"metrics" => "conversion_rate"
})
assert json_response(conn, 200) == %{
"results" => [
%{
"author" => "Uku",
"conversion_rate" => 50
}
]
}
end
test "returns conversion_rate in a goal filtered event:page breakdown", %{
conn: conn,
site: site
} do
populate_stats(site, [
build(:event, pathname: "/en/register", name: "pageview"),
build(:event, pathname: "/en/register", name: "Signup"),
build(:event, pathname: "/en/register", name: "Signup"),
build(:event, pathname: "/it/register", name: "Signup", user_id: 1),
build(:event, pathname: "/it/register", name: "Signup", user_id: 1),
build(:event, pathname: "/it/register", name: "pageview")
])
insert(:goal, %{site: site, event_name: "Signup"})
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"period" => "day",
"property" => "event:page",
"filters" => "event:goal==Signup",
"metrics" => "visitors,events,conversion_rate"
})
assert json_response(conn, 200) == %{
"results" => [
%{
"page" => "/en/register",
"visitors" => 2,
"events" => 2,
"conversion_rate" => 66.67
},
%{
"page" => "/it/register",
"visitors" => 1,
"events" => 2,
"conversion_rate" => 50
}
]
}
end
test "returns conversion_rate alone in a goal filtered event:page breakdown", %{
conn: conn,
site: site
} do
populate_stats(site, [
build(:event, pathname: "/en/register", name: "pageview"),
build(:event, pathname: "/en/register", name: "Signup")
])
insert(:goal, %{site: site, event_name: "Signup"})
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"period" => "day",
"property" => "event:page",
"filters" => "event:goal==Signup",
"metrics" => "conversion_rate"
})
assert json_response(conn, 200) == %{
"results" => [
%{
"page" => "/en/register",
"conversion_rate" => 50
}
]
}
end
test "returns conversion_rate in a multi-goal filtered visit:screen_size breakdown", %{
conn: conn,
site: site
} do
populate_stats(site, [
build(:event, screen_size: "Mobile", name: "pageview"),
build(:event, screen_size: "Mobile", name: "AddToCart"),
build(:event, screen_size: "Mobile", name: "AddToCart"),
build(:event, screen_size: "Desktop", name: "AddToCart", user_id: 1),
build(:event, screen_size: "Desktop", name: "Purchase", user_id: 1),
build(:event, screen_size: "Desktop", name: "pageview")
])
# Make sure that revenue goals are treated the same
# way as regular custom event goals
insert(:goal, %{site: site, event_name: "Purchase", currency: :EUR})
insert(:goal, %{site: site, event_name: "AddToCart"})
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"period" => "day",
"property" => "visit:device",
"filters" => "event:goal==AddToCart|Purchase",
"metrics" => "visitors,events,conversion_rate"
})
assert json_response(conn, 200) == %{
"results" => [
%{
"device" => "Mobile",
"visitors" => 2,
"events" => 2,
"conversion_rate" => 66.67
},
%{
"device" => "Desktop",
"visitors" => 1,
"events" => 2,
"conversion_rate" => 50
}
]
}
end
test "returns conversion_rate alone in a goal filtered visit:screen_size breakdown", %{
conn: conn,
site: site
} do
populate_stats(site, [
build(:event, screen_size: "Mobile", name: "pageview"),
build(:event, screen_size: "Mobile", name: "AddToCart")
])
insert(:goal, %{site: site, event_name: "AddToCart"})
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"period" => "day",
"property" => "visit:device",
"filters" => "event:goal==AddToCart",
"metrics" => "conversion_rate"
})
assert json_response(conn, 200) == %{
"results" => [
%{
"device" => "Mobile",
"conversion_rate" => 50
}
]
}
end
test "returns conversion_rate for a browser_version breakdown with pagination limit", %{
site: site,
conn: conn
} do
populate_stats(site, [
build(:pageview, browser: "Firefox", browser_version: "110"),
build(:pageview, browser: "Firefox", browser_version: "110"),
build(:pageview, browser: "Chrome", browser_version: "110"),
build(:pageview, browser: "Chrome", browser_version: "110"),
build(:pageview, browser: "Avast Secure Browser", browser_version: "110"),
build(:pageview, browser: "Avast Secure Browser", browser_version: "110"),
build(:event, name: "Signup", browser: "Edge", browser_version: "110")
])
insert(:goal, site: site, event_name: "Signup")
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"period" => "day",
"property" => "visit:browser_version",
"filters" => "event:goal==Signup",
"metrics" => "visitors,conversion_rate",
"page" => 1,
"limit" => 1
})
assert json_response(conn, 200) == %{
"results" => [
%{
"browser" => "Edge",
"browser_version" => "110",
"visitors" => 1,
"conversion_rate" => 100.0
}
]
}
end
test "all metrics for breakdown by visit prop", %{conn: conn, site: site} do
populate_stats(site, [
build(:pageview,
user_id: 1,
referrer_source: "Google",
timestamp: ~N[2021-01-01 00:00:00]
),
build(:event,
name: "signup",
user_id: 1,
referrer_source: "Google",
timestamp: ~N[2021-01-01 00:05:00]
),
build(:pageview,
user_id: 1,
referrer_source: "Google",
timestamp: ~N[2021-01-01 00:10:00]
),
build(:pageview,
referrer_source: "Google",
timestamp: ~N[2021-01-01 00:25:00]
),
build(:pageview,
referrer_source: "Twitter",
timestamp: ~N[2021-01-01 00:00:00]
)
])
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"period" => "day",
"date" => "2021-01-01",
"property" => "visit:source",
"metrics" => "visitors,visits,pageviews,events,bounce_rate,visit_duration"
})
assert json_response(conn, 200) == %{
"results" => [
%{
"source" => "Google",
"visitors" => 2,
"visits" => 2,
"bounce_rate" => 50,
"visit_duration" => 300,
"pageviews" => 3,
"events" => 4
},
%{
"source" => "Twitter",
"visitors" => 1,
"visits" => 1,
"bounce_rate" => 100,
"visit_duration" => 0,
"pageviews" => 1,
"events" => 1
}
]
}
end
test "metrics=bounce_rate does not add visits to the response", %{conn: conn, site: site} do
populate_stats(site, [
build(:pageview,
user_id: 1,
pathname: "/entry-page-1",
timestamp: ~N[2021-01-01 00:00:00]
),
build(:pageview,
user_id: 1,
pathname: "/some-page",
timestamp: ~N[2021-01-01 00:10:00]
),
build(:pageview,
user_id: 2,
pathname: "/entry-page-2",
referrer_source: "Google",
timestamp: ~N[2021-01-01 00:05:00]
)
])
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"period" => "day",
"date" => "2021-01-01",
"property" => "visit:entry_page",
"metrics" => "bounce_rate"
})
assert json_response(conn, 200) == %{
"results" => [
%{
"entry_page" => "/entry-page-2",
"bounce_rate" => 100
},
%{
"entry_page" => "/entry-page-1",
"bounce_rate" => 0
}
]
}
end
test "filter by custom event property", %{conn: conn, site: site} do
populate_stats(site, [
build(:event,
name: "Purchase",
"meta.key": ["package"],
"meta.value": ["business"],
browser: "Chrome",
timestamp: ~N[2021-01-01 00:00:00]
),
build(:event,
name: "Purchase",
"meta.key": ["package"],
"meta.value": ["business"],
browser: "Safari",
timestamp: ~N[2021-01-01 00:00:00]
),
build(:event,
name: "Purchase",
"meta.key": ["package"],
"meta.value": ["business"],
browser: "Safari",
timestamp: ~N[2021-01-01 00:25:00]
),
build(:event,
name: "Purchase",
"meta.key": ["package"],
"meta.value": ["personal"],
browser: "IE",
timestamp: ~N[2021-01-01 00:25:00]
)
])
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"period" => "day",
"date" => "2021-01-01",
"property" => "visit:browser",
"filters" => "event:name==Purchase;event:props:package==business"
})
assert json_response(conn, 200) == %{
"results" => [
%{"browser" => "Safari", "visitors" => 2},
%{"browser" => "Chrome", "visitors" => 1}
]
}
end
test "all metrics for breakdown by event prop", %{conn: conn, site: site} do
populate_stats(site, [
build(:pageview,
user_id: 1,
pathname: "/",
timestamp: ~N[2021-01-01 00:00:00]
),
build(:pageview,
user_id: 1,
pathname: "/plausible.io",
timestamp: ~N[2021-01-01 00:10:00]
),
build(:pageview, pathname: "/", timestamp: ~N[2021-01-01 00:25:00]),
build(:pageview,
pathname: "/plausible.io",
timestamp: ~N[2021-01-01 00:00:00]
)
])
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"period" => "day",
"date" => "2021-01-01",
"property" => "event:page",
"metrics" => "visitors,pageviews,events,bounce_rate,visit_duration"
})
assert json_response(conn, 200) == %{
"results" => [
%{
"page" => "/",
"visitors" => 2,
"bounce_rate" => 50,
"visit_duration" => 300,
"pageviews" => 2,
"events" => 2
},
%{
"page" => "/plausible.io",
# Breaks for event:page breakdown since visitors is calculated based on entry_page :/
"visitors" => 2,
"bounce_rate" => 100,
"visit_duration" => 0,
"pageviews" => 2,
"events" => 2
}
]
}
end
end
describe "imported data" do
test "returns screen sizes breakdown when filtering by screen size", %{conn: conn, site: site} do
site_import = insert(:site_import, site: site)
populate_stats(site, site_import.id, [
build(:pageview,
timestamp: ~N[2021-01-01 00:00:01],
screen_size: "Mobile"
),
build(:imported_devices,
device: "Mobile",
visitors: 3,
pageviews: 5,
date: ~D[2021-01-01]
)
])
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"period" => "day",
"date" => "2021-01-01",
"property" => "visit:device",
"filters" => "visit:device==Mobile",
"metrics" => "visitors,pageviews",
"with_imported" => "true"
})
assert [%{"pageviews" => 6, "visitors" => 4, "device" => "Mobile"}] =
json_response(conn, 200)["results"]
end
test "returns custom event goals and pageview goals", %{conn: conn, site: site} do
insert(:goal, site: site, event_name: "Purchase")
insert(:goal, site: site, page_path: "/test")
site_import = insert(:site_import, site: site)
populate_stats(site, site_import.id, [
build(:pageview,
timestamp: ~N[2021-01-01 00:00:01],
pathname: "/test"
),
build(:event,
name: "Purchase",
timestamp: ~N[2021-01-01 00:00:03]
),
build(:event,
name: "Purchase",
timestamp: ~N[2021-01-01 00:00:03]
),
build(:imported_custom_events,
name: "Purchase",
visitors: 3,
events: 5,
date: ~D[2021-01-01]
),
build(:imported_pages,
page: "/test",
visitors: 2,
pageviews: 2,
date: ~D[2021-01-01]
),
build(:imported_visitors, visitors: 5, date: ~D[2021-01-01])
])
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"period" => "day",
"date" => "2021-01-01",
"property" => "event:goal",
"metrics" => "visitors,events,pageviews,conversion_rate",
"with_imported" => "true"
})
assert [
%{
"goal" => "Purchase",
"visitors" => 5,
"events" => 7,
"pageviews" => 0,
"conversion_rate" => 62.5
},
%{
"goal" => "Visit /test",
"visitors" => 3,
"events" => 3,
"pageviews" => 3,
"conversion_rate" => 37.5
}
] = json_response(conn, 200)["results"]
end
test "pageviews are returned as events for breakdown reports other than custom events", %{
conn: conn,
site: site
} do
site_import = insert(:site_import, site: site)
populate_stats(site, site_import.id, [
build(:imported_browsers, browser: "Chrome", pageviews: 1, date: ~D[2021-01-01]),
build(:imported_devices, device: "Desktop", pageviews: 1, date: ~D[2021-01-01]),
build(:imported_entry_pages, entry_page: "/test", pageviews: 1, date: ~D[2021-01-01]),
build(:imported_exit_pages, exit_page: "/test", pageviews: 1, date: ~D[2021-01-01]),
build(:imported_locations, country: "EE", pageviews: 1, date: ~D[2021-01-01]),
build(:imported_operating_systems,
operating_system: "Mac",
pageviews: 1,
date: ~D[2021-01-01]
),
build(:imported_pages, page: "/test", pageviews: 1, date: ~D[2021-01-01]),
build(:imported_sources, source: "Google", pageviews: 1, date: ~D[2021-01-01])
])
params = %{
"site_id" => site.domain,
"period" => "day",
"date" => "2021-01-01",
"metrics" => "events",
"with_imported" => "true"
}
breakdown_and_first = fn property ->
conn
|> get("/api/v1/stats/breakdown", Map.put(params, "property", property))
|> json_response(200)
|> Map.get("results")
|> List.first()
end
assert %{"browser" => "Chrome", "events" => 1} = breakdown_and_first.("visit:browser")
assert %{"device" => "Desktop", "events" => 1} = breakdown_and_first.("visit:device")
assert %{"country" => "EE", "events" => 1} = breakdown_and_first.("visit:country")
assert %{"os" => "Mac", "events" => 1} = breakdown_and_first.("visit:os")
assert %{"page" => "/test", "events" => 1} = breakdown_and_first.("event:page")
assert %{"source" => "Google", "events" => 1} = breakdown_and_first.("visit:source")
end
for event_name <- Plausible.Event.SystemEvents.events_with_url_prop() do
test "returns url breakdown for #{event_name} goal", %{conn: conn, site: site} do
insert(:goal, event_name: unquote(event_name), site: site)
site_import = insert(:site_import, site: site)
populate_stats(site, site_import.id, [
build(:event,
name: unquote(event_name),
"meta.key": ["url"],
"meta.value": ["https://one.com"]
),
build(:imported_custom_events,
name: unquote(event_name),
visitors: 2,
events: 5,
link_url: "https://one.com"
),
build(:imported_custom_events,
name: unquote(event_name),
visitors: 5,
events: 10,
link_url: "https://two.com"
),
build(:imported_custom_events,
name: "some goal",
visitors: 5,
events: 10
),
build(:imported_visitors, visitors: 9)
])
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"period" => "day",
"property" => "event:props:url",
"filters" => "event:goal==#{unquote(event_name)}",
"metrics" => "visitors,events,conversion_rate",
"with_imported" => "true"
})
assert json_response(conn, 200)["results"] == [
%{
"visitors" => 5,
"url" => "https://two.com",
"events" => 10,
"conversion_rate" => 50.0
},
%{
"visitors" => 3,
"url" => "https://one.com",
"events" => 6,
"conversion_rate" => 30.0
}
]
refute json_response(conn, 200)["warning"]
end
end
for event_name <- Plausible.Event.SystemEvents.events_with_path_prop() do
test "returns path breakdown for #{event_name} goal", %{conn: conn, site: site} do
insert(:goal, event_name: unquote(event_name), site: site)
site_import = insert(:site_import, site: site)
populate_stats(site, site_import.id, [
build(:event,
name: unquote(event_name),
"meta.key": ["path"],
"meta.value": ["/one"]
),
build(:imported_custom_events,
name: unquote(event_name),
visitors: 2,
events: 5,
path: "/one"
),
build(:imported_custom_events,
name: unquote(event_name),
visitors: 5,
events: 10,
path: "/two"
),
build(:imported_custom_events,
name: "some goal",
visitors: 5,
events: 10
),
build(:imported_visitors, visitors: 9)
])
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"period" => "day",
"property" => "event:props:path",
"filters" => "event:goal==#{unquote(event_name)}",
"metrics" => "visitors,events,conversion_rate",
"with_imported" => "true"
})
assert json_response(conn, 200)["results"] == [
%{
"visitors" => 5,
"path" => "/two",
"events" => 10,
"conversion_rate" => 50.0
},
%{
"visitors" => 3,
"path" => "/one",
"events" => 6,
"conversion_rate" => 30.0
}
]
refute json_response(conn, 200)["warning"]
end
end
test "adds a warning when query params are not supported for imported data", %{
conn: conn,
site: site
} do
site_import = insert(:site_import, site: site)
insert(:goal, event_name: "Signup", site: site)
populate_stats(site, site_import.id, [
build(:event,
name: "Signup",
"meta.key": ["package"],
"meta.value": ["large"]
),
build(:imported_visitors, visitors: 9)
])
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"period" => "day",
"property" => "event:props:package",
"filters" => "event:goal==Signup",
"metrics" => "visitors",
"with_imported" => "true"
})
assert json_response(conn, 200)["results"] == [
%{
"package" => "large",
"visitors" => 1
}
]
assert json_response(conn, 200)["warning"] =~
"Imported stats are not included in the results because query parameters are not supported."
end
test "does not add a warning when there are no site imports", %{conn: conn, site: site} do
insert(:goal, event_name: "Signup", site: site)
populate_stats(site, [
build(:event,
name: "Signup",
"meta.key": ["package"],
"meta.value": ["large"]
)
])
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"period" => "day",
"property" => "event:props:package",
"filters" => "event:goal==Signup",
"metrics" => "visitors",
"with_imported" => "true"
})
refute json_response(conn, 200)["warning"]
end
test "does not add a warning when import is out of queried date range", %{
conn: conn,
site: site
} do
site_import = insert(:site_import, site: site, end_date: Date.add(Date.utc_today(), -3))
insert(:goal, event_name: "Signup", site: site)
populate_stats(site, site_import.id, [
build(:event,
name: "Signup",
"meta.key": ["package"],
"meta.value": ["large"]
),
build(:imported_visitors, visitors: 9)
])
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"period" => "day",
"property" => "event:props:package",
"filters" => "event:goal==Signup",
"metrics" => "visitors",
"with_imported" => "true"
})
refute json_response(conn, 200)["warning"]
end
test "applies multiple filters if the properties belong to the same table", %{
conn: conn,
site: site
} do
site_import = insert(:site_import, site: site)
populate_stats(site, site_import.id, [
build(:imported_sources, source: "Google", utm_medium: "organic", utm_term: "one"),
build(:imported_sources, source: "Twitter", utm_medium: "organic", utm_term: "two"),
build(:imported_sources,
source: "Facebook",
utm_medium: "something_else",
utm_term: "one"
)
])
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"period" => "day",
"property" => "visit:source",
"filters" => "visit:utm_medium==organic;visit:utm_term==one",
"with_imported" => "true"
})
assert json_response(conn, 200) == %{
"results" => [%{"source" => "Google", "visitors" => 1}]
}
end
test "ignores imported data if filtered property belongs to a different table than the breakdown property",
%{
conn: conn,
site: site
} do
site_import = insert(:site_import, site: site)
populate_stats(site, site_import.id, [
build(:imported_sources, source: "Google"),
build(:imported_devices, device: "Desktop")
])
conn =
get(conn, "/api/v1/stats/breakdown", %{
"site_id" => site.domain,
"period" => "day",
"property" => "visit:source",
"filters" => "visit:device==Desktop",
"with_imported" => "true"
})
assert %{
"results" => [],
"warning" => warning
} = json_response(conn, 200)
assert warning =~ "Imported stats are not included in the results"
end
end
end