Skip to content

armgit / umami

Public Imported from GitHub
0

Umami is a privacy-first web and product analytics platform. Traffic, campaigns, behavior, conversions, and revenue in one place. No cookies, no surveillance, self-hosted or in the cloud.

Breakdown feature for insights report.

Mike Caof48720c9159d
diff --git a/components/messages.js b/components/messages.js
index a31e28751..286a5788f 100644
--- a/components/messages.js
+++ b/components/messages.js
@@ -162,6 +162,13 @@ export const labels = defineMessages({
totalRecords: { id: 'labels.total-records', defaultMessage: 'Total records' },
insights: { id: 'label.insights', defaultMessage: 'Insights' },
dropoff: { id: 'label.dropoff', defaultMessage: 'Dropoff' },
+ referrer: { id: 'label.referrer', defaultMessage: 'Referrer' },
+ country: { id: 'label.country', defaultMessage: 'Country' },
+ region: { id: 'label.region', defaultMessage: 'Region' },
+ city: { id: 'label.city', defaultMessage: 'City' },
+ browser: { id: 'label.browser', defaultMessage: 'Browser' },
+ device: { id: 'label.device', defaultMessage: 'Device' },
+ pageTitle: { id: 'label.pageTitle', defaultMessage: 'Page title' },
});
export const messages = defineMessages({
diff --git a/components/pages/reports/ReportDetails.js b/components/pages/reports/ReportDetails.js
index c41d12f6a..df1307609 100644
--- a/components/pages/reports/ReportDetails.js
+++ b/components/pages/reports/ReportDetails.js
@@ -1,9 +1,11 @@
import FunnelReport from './funnel/FunnelReport';
import EventDataReport from './event-data/EventDataReport';
+import InsightsReport from './insights/InsightsReport';
const reports = {
funnel: FunnelReport,
'event-data': EventDataReport,
+ insights: InsightsReport,
};
export default function ReportDetails({ reportId, reportType }) {
diff --git a/components/pages/reports/insights/InsightsParameters.js b/components/pages/reports/insights/InsightsParameters.js
index 5b9b8f185..5d7e1fca4 100644
--- a/components/pages/reports/insights/InsightsParameters.js
+++ b/components/pages/reports/insights/InsightsParameters.js
@@ -11,20 +11,6 @@ import PopupForm from '../PopupForm';
import FilterSelectForm from '../FilterSelectForm';
import FieldSelectForm from '../FieldSelectForm';
-const fieldOptions = [
- { name: 'url', type: 'string' },
- { name: 'title', type: 'string' },
- { name: 'referrer', type: 'string' },
- { name: 'query', type: 'string' },
- { name: 'browser', type: 'string' },
- { name: 'os', type: 'string' },
- { name: 'device', type: 'string' },
- { name: 'country', type: 'string' },
- { name: 'region', type: 'string' },
- { name: 'city', type: 'string' },
- { name: 'language', type: 'string' },
-];
-
export function InsightsParameters() {
const { report, runReport, updateReport, isRunning } = useContext(ReportContext);
const { formatMessage, labels } = useMessages();
@@ -33,9 +19,23 @@ export function InsightsParameters() {
const { websiteId, dateRange, filters, groups } = parameters || {};
const queryEnabled = websiteId && dateRange && (filters?.length || groups?.length);
+ const fieldOptions = [
+ { name: 'url_path', type: 'string', label: formatMessage(labels.url) },
+ { name: 'page_title', type: 'string', label: formatMessage(labels.pageTitle) },
+ { name: 'referrer_domain', type: 'string', label: formatMessage(labels.referrer) },
+ { name: 'url_query', type: 'string', label: formatMessage(labels.query) },
+ { name: 'browser', type: 'string', label: formatMessage(labels.browser) },
+ { name: 'os', type: 'string', label: formatMessage(labels.os) },
+ { name: 'device', type: 'string', label: formatMessage(labels.device) },
+ { name: 'country', type: 'string', label: formatMessage(labels.country) },
+ { name: 'region', type: 'string', label: formatMessage(labels.region) },
+ { name: 'city', type: 'string', label: formatMessage(labels.city) },
+ { name: 'language', type: 'string', label: formatMessage(labels.language) },
+ ];
+
const parameterGroups = [
- { label: formatMessage(labels.filters), group: REPORT_PARAMETERS.filters },
{ label: formatMessage(labels.breakdown), group: REPORT_PARAMETERS.groups },
+ { label: formatMessage(labels.filters), group: REPORT_PARAMETERS.filters },
];
const parameterData = {
@@ -71,12 +71,12 @@ export function InsightsParameters() {
{(close, element) => {
return (
<PopupForm element={element} onClose={close}>
- {group === REPORT_PARAMETERS.filters && (
- <FilterSelectForm fields={fieldOptions} onSelect={handleAdd.bind(null, group)} />
- )}
{group === REPORT_PARAMETERS.groups && (
<FieldSelectForm fields={fieldOptions} onSelect={handleAdd.bind(null, group)} />
)}
+ {group === REPORT_PARAMETERS.filters && (
+ <FilterSelectForm fields={fieldOptions} onSelect={handleAdd.bind(null, group)} />
+ )}
</PopupForm>
);
}}
@@ -95,19 +95,19 @@ export function InsightsParameters() {
items={parameterData[group]}
onRemove={index => handleRemove(group, index)}
>
- {({ name, value }) => {
+ {({ value, label }) => {
return (
<div className={styles.parameter}>
- {group === REPORT_PARAMETERS.filters && (
+ {group === REPORT_PARAMETERS.groups && (
<>
- <div>{name}</div>
- <div className={styles.op}>{value[0]}</div>
- <div>{value[1]}</div>
+ <div>{label}</div>
</>
)}
- {group === REPORT_PARAMETERS.groups && (
+ {group === REPORT_PARAMETERS.filters && (
<>
- <div>{name}</div>
+ <div>{label}</div>
+ <div className={styles.op}>{value[0]}</div>
+ <div>{value[1]}</div>
</>
)}
</div>
diff --git a/components/pages/reports/insights/InsightsTable.js b/components/pages/reports/insights/InsightsTable.js
index d751445b9..7832a899a 100644
--- a/components/pages/reports/insights/InsightsTable.js
+++ b/components/pages/reports/insights/InsightsTable.js
@@ -6,14 +6,15 @@ import { ReportContext } from '../Report';
export function InsightsTable() {
const { report } = useContext(ReportContext);
const { formatMessage, labels } = useMessages();
- const { fields = [] } = report?.parameters || {};
+ const { groups = [] } = report?.parameters || {};
return (
<GridTable data={report?.data || []}>
- {fields.map(({ name }) => {
- return <GridColumn key={name} name={name} label={name} />;
+ {groups.map(({ name, label }) => {
+ return <GridColumn key={name} name={name} label={label} />;
})}
- <GridColumn name="total" label={formatMessage(labels.total)} />
+ <GridColumn name="views" label={formatMessage(labels.views)} width="100px" />
+ <GridColumn name="visitors" label={formatMessage(labels.visitors)} width="100px" />
</GridTable>
);
}
diff --git a/pages/api/reports/insights.ts b/pages/api/reports/insights.ts
index f245153ff..44f720637 100644
--- a/pages/api/reports/insights.ts
+++ b/pages/api/reports/insights.ts
@@ -13,7 +13,7 @@ export interface InsightsRequestBody {
};
fields: { name: string; type: string; value: string }[];
filters: string[];
- groups: string[];
+ groups: { name: string; type: string }[];
}
export default async (
@@ -27,24 +27,19 @@ export default async (
const {
websiteId,
dateRange: { startDate, endDate },
- fields,
- filters,
groups,
+ filters,
} = req.body;
if (!(await canViewWebsite(req.auth, websiteId))) {
return unauthorized(res);
}
- const data = await getInsights(
- websiteId,
- {
- ...filters,
- startDate: new Date(startDate),
- endDate: new Date(endDate),
- },
- groups,
- );
+ const data = await getInsights(websiteId, groups, {
+ ...filters,
+ startDate: new Date(startDate),
+ endDate: new Date(endDate),
+ });
return ok(res, data);
}
diff --git a/queries/analytics/reports/getInsights.ts b/queries/analytics/reports/getInsights.ts
index 93569fe74..0f778555a 100644
--- a/queries/analytics/reports/getInsights.ts
+++ b/queries/analytics/reports/getInsights.ts
@@ -5,7 +5,7 @@ import { EVENT_TYPE } from 'lib/constants';
import { QueryFilters } from 'lib/types';
export async function getInsights(
- ...args: [websiteId: string, filters: QueryFilters, groups: { name: string; type: string }[]]
+ ...args: [websiteId: string, groups: { name: string; type: string }[], filters: QueryFilters]
) {
return runQuery({
[PRISMA]: () => relationalQuery(...args),
@@ -15,8 +15,8 @@ export async function getInsights(
async function relationalQuery(
websiteId: string,
- filters: QueryFilters,
groups: { name: string; type: string }[],
+ filters: QueryFilters,
): Promise<
{
x: string;
@@ -48,8 +48,8 @@ async function relationalQuery(
async function clickhouseQuery(
websiteId: string,
- filters: QueryFilters,
groups: { name: string; type: string }[],
+ filters: QueryFilters,
): Promise<
{
x: string;