Skip to content

🐸 Rybbit - open-source and privacy-friendly alternative to Google Analytics that is 10x more intuitive.

Enhance Filters component with region support and improved parameter handling

Bill Yang9907f48dc2ef
diff --git a/client/src/app/[site]/components/SubHeader/Filters/Filters.tsx b/client/src/app/[site]/components/SubHeader/Filters/Filters.tsx
index 844a1201c..8a24de7ae 100644
--- a/client/src/app/[site]/components/SubHeader/Filters/Filters.tsx
+++ b/client/src/app/[site]/components/SubHeader/Filters/Filters.tsx
@@ -9,6 +9,7 @@ import {
} from "../../../../../lib/store";
import { getCountryName } from "../../../../../lib/utils";
import { NewFilterButton } from "./NewFilterButton";
+import { useGetRegionName } from "../../../../../lib/geo";
function getParameterNameLabel(parameter: FilterParameter) {
switch (parameter) {
@@ -34,6 +35,8 @@ function getParameterNameLabel(parameter: FilterParameter) {
return "City";
case "region":
return "Region";
+ case "iso_3166_2":
+ return "Region";
default:
return parameter;
}
@@ -52,11 +55,17 @@ const filterTypeToLabel = (type: FilterType) => {
}
};
-function getParameterValueLabel(filter: Filter) {
+function getParameterValueLabel(
+ filter: Filter,
+ getRegionName: (iso_3166_2: string) => string | undefined
+) {
const formatValue = (value: string) => {
if (filter.parameter === "country") {
return getCountryName(value);
}
+ if (filter.parameter === "iso_3166_2") {
+ return getRegionName(value);
+ }
return value;
};
@@ -70,6 +79,7 @@ function getParameterValueLabel(filter: Filter) {
export function Filters() {
const { filters } = useStore();
+ const { getRegionName } = useGetRegionName();
return (
<div className="flex gap-2">
@@ -106,7 +116,7 @@ export function Filters() {
{filterTypeToLabel(filter.type)}
</div>
<div className="text-neutral-100 font-medium">
- {getParameterValueLabel(filter)}
+ {getParameterValueLabel(filter, getRegionName)}
</div>
<div
className="text-neutral-400 cursor-pointer hover:text-neutral-200"
diff --git a/client/src/app/[site]/components/SubHeader/Filters/NewFilterButton.tsx b/client/src/app/[site]/components/SubHeader/Filters/NewFilterButton.tsx
index f8bbbd1d4..6f9bf03f6 100644
--- a/client/src/app/[site]/components/SubHeader/Filters/NewFilterButton.tsx
+++ b/client/src/app/[site]/components/SubHeader/Filters/NewFilterButton.tsx
@@ -36,7 +36,7 @@ const FilterOptions: { label: string; value: FilterParameter }[] = [
},
{
label: "Region",
- value: "region",
+ value: "iso_3166_2",
},
{
label: "City",
diff --git a/client/src/app/[site]/components/SubHeader/Filters/ValueFilter.tsx b/client/src/app/[site]/components/SubHeader/Filters/ValueFilter.tsx
index 547499548..e95fa3b25 100644
--- a/client/src/app/[site]/components/SubHeader/Filters/ValueFilter.tsx
+++ b/client/src/app/[site]/components/SubHeader/Filters/ValueFilter.tsx
@@ -10,6 +10,7 @@ import { FilterParameter, addFilter } from "../../../../../lib/store";
import { MultiSelect } from "../../../../../components/MultiSelect";
import { useSingleCol } from "../../../../../api/analytics/useSingleCol";
+import { useGetRegionName } from "../../../../../lib/geo";
interface ValueFilterProps {
parameter: FilterParameter;
@@ -26,6 +27,7 @@ export function ValueFilter({ parameter, type, onComplete }: ValueFilterProps) {
useFilters: false,
});
+ const { getRegionName } = useGetRegionName();
const [selectedValues, setSelectedValues] = useState<string[]>([]);
const suggestions = useMemo(() => {
@@ -40,6 +42,12 @@ export function ValueFilter({ parameter, type, onComplete }: ValueFilterProps) {
label: getCountryName(val),
};
}
+ if (parameter === "iso_3166_2") {
+ return {
+ value: val,
+ label: getRegionName(val),
+ };
+ }
return {
value: val,
label: val,
diff --git a/client/src/app/[site]/main/components/sections/Countries.tsx b/client/src/app/[site]/main/components/sections/Countries.tsx
index 3fa0d67c2..2e79fb966 100644
--- a/client/src/app/[site]/main/components/sections/Countries.tsx
+++ b/client/src/app/[site]/main/components/sections/Countries.tsx
@@ -71,7 +71,6 @@ export function Countries() {
getValue={(e) => e.value}
getKey={(e) => e.value}
getLabel={(e) => {
- console.info(e.value);
return (
<div className="flex gap-2 items-center">
<CountryFlag country={e.value} />
diff --git a/client/src/lib/geo.ts b/client/src/lib/geo.ts
index 972201d2a..e1c3f1a0d 100644
--- a/client/src/lib/geo.ts
+++ b/client/src/lib/geo.ts
@@ -50,3 +50,15 @@ export const useCountries = () => {
queryFn: () => fetch(countriesGeoUrl).then((res) => res.json()),
});
};
+
+export const useGetRegionName = () => {
+ const { data: subdivisions } = useSubdivisions();
+
+ return {
+ getRegionName: (iso_3166_2: string) => {
+ return subdivisions?.features.find(
+ (feature) => feature.properties.iso_3166_2 === iso_3166_2
+ )?.properties.name;
+ },
+ };
+};
diff --git a/server/src/api/getSingleCol.ts b/server/src/api/getSingleCol.ts
index 14ad9ce61..fa68425de 100644
--- a/server/src/api/getSingleCol.ts
+++ b/server/src/api/getSingleCol.ts
@@ -40,21 +40,6 @@ const getQuery = (request: GenericRequest["Querystring"]) => {
2
) as percentage`;
- if (parameter === "dimensions") {
- return `
- SELECT
- concat(toString(screen_width), 'x', toString(screen_height)) AS value,
- COUNT(distinct(session_id)) as count,
- ${percentageStatement}
- FROM pageviews
- WHERE
- site_id = ${site}
- ${filterStatement}
- ${getTimeStatement(startDate, endDate, timezone)}
- GROUP BY value ORDER BY count desc
- ${limit ? `LIMIT ${limit}` : ""};`;
- }
-
// if (["querystring", "page_title", "pathname"].includes(parameter)) {
// }
@@ -72,7 +57,9 @@ const getQuery = (request: GenericRequest["Querystring"]) => {
FROM pageviews
WHERE
site_id = ${site}
+ ${filterStatement}
${getTimeStatement(startDate, endDate, timezone)}
+ AND type = 'pageview'
GROUP BY session_id
) AS exit_pages
GROUP BY value ORDER BY count desc
@@ -93,7 +80,9 @@ const getQuery = (request: GenericRequest["Querystring"]) => {
FROM pageviews
WHERE
site_id = ${site}
+ ${filterStatement}
${getTimeStatement(startDate, endDate, timezone)}
+ AND type = 'pageview'
GROUP BY session_id
) AS entry_pages
GROUP BY value ORDER BY count desc
diff --git a/server/src/api/utils.ts b/server/src/api/utils.ts
index 33b6168e0..c175966b8 100644
--- a/server/src/api/utils.ts
+++ b/server/src/api/utils.ts
@@ -58,6 +58,15 @@ export const geSqlParam = (parameter: FilterParameter) => {
if (parameter === "referrer") {
return "domainWithoutWWW(referrer)";
}
+ if (parameter === "entry_page") {
+ return "(SELECT argMin(pathname, timestamp) FROM pageviews WHERE session_id = pageviews.session_id)";
+ }
+ if (parameter === "exit_page") {
+ return "(SELECT argMax(pathname, timestamp) FROM pageviews WHERE session_id = pageviews.session_id)";
+ }
+ if (parameter === "dimensions") {
+ return "concat(toString(screen_width), 'x', toString(screen_height))";
+ }
return parameter;
};
@@ -78,6 +87,80 @@ export function getFilterStatement(filters: string) {
? "%"
: "";
+ if (filter.parameter === "entry_page") {
+ if (filter.value.length === 1) {
+ return `session_id IN (
+ SELECT session_id
+ FROM (
+ SELECT
+ session_id,
+ argMin(pathname, timestamp) AS entry_pathname
+ FROM pageviews
+ GROUP BY session_id
+ )
+ WHERE entry_pathname ${filterTypeToOperator(filter.type)} '${x}${
+ filter.value[0]
+ }${x}'
+ )`;
+ }
+
+ const valuesWithOperator = filter.value.map(
+ (value) =>
+ `entry_pathname ${filterTypeToOperator(
+ filter.type
+ )} '${x}${value}${x}'`
+ );
+
+ return `session_id IN (
+ SELECT session_id
+ FROM (
+ SELECT
+ session_id,
+ argMin(pathname, timestamp) AS entry_pathname
+ FROM pageviews
+ GROUP BY session_id
+ )
+ WHERE (${valuesWithOperator.join(" OR ")})
+ )`;
+ }
+
+ if (filter.parameter === "exit_page") {
+ if (filter.value.length === 1) {
+ return `session_id IN (
+ SELECT session_id
+ FROM (
+ SELECT
+ session_id,
+ argMax(pathname, timestamp) AS exit_pathname
+ FROM pageviews
+ GROUP BY session_id
+ )
+ WHERE exit_pathname ${filterTypeToOperator(filter.type)} '${x}${
+ filter.value[0]
+ }${x}'
+ )`;
+ }
+
+ const valuesWithOperator = filter.value.map(
+ (value) =>
+ `exit_pathname ${filterTypeToOperator(
+ filter.type
+ )} '${x}${value}${x}'`
+ );
+
+ return `session_id IN (
+ SELECT session_id
+ FROM (
+ SELECT
+ session_id,
+ argMax(pathname, timestamp) AS exit_pathname
+ FROM pageviews
+ GROUP BY session_id
+ )
+ WHERE (${valuesWithOperator.join(" OR ")})
+ )`;
+ }
+
if (filter.value.length === 1) {
return `${geSqlParam(filter.parameter)} ${filterTypeToOperator(
filter.type