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.
TypeScript analyticsaudience-segmentationchartscohort-analysisgoogle-analyticsproduct-analyticsstatisticsuser-journeyweb-analytics
Added query hooks for website events and metrics.
Mike Caoc7df1063ac0e
diff --git a/src/components/hooks/index.js b/src/components/hooks/index.jsindex cdb05a6d8..9e9993c3a 100644--- a/src/components/hooks/index.js+++ b/src/components/hooks/index.js@@ -11,6 +11,8 @@ export * from './queries/useUser';export * from './queries/useUsers';export * from './queries/useWebsite';export * from './queries/useWebsites';+export * from './queries/useWebsiteEvents';+export * from './queries/useWebsiteMetrics';export * from './useCountryNames';export * from './useDateRange';export * from './useDocumentClick';diff --git a/src/components/hooks/queries/useWebsiteEvents.ts b/src/components/hooks/queries/useWebsiteEvents.tsnew file mode 100644index 000000000..de18a1f90--- /dev/null+++ b/src/components/hooks/queries/useWebsiteEvents.ts@@ -0,0 +1,19 @@+import useApi from './useApi';+import { UseQueryOptions } from '@tanstack/react-query';++export function useWebsiteEvents(+ websiteId: string,+ params?: { [key: string]: any },+ options?: Omit<UseQueryOptions, 'queryKey' | 'queryFn'>,+) {+ const { get, useQuery } = useApi();++ return useQuery({+ queryKey: ['events', { ...params }],+ queryFn: () => get(`/websites/${websiteId}/events`, { ...params }),+ enabled: !!websiteId,+ ...options,+ });+}++export default useWebsiteEvents;diff --git a/src/components/hooks/queries/useWebsiteMetrics.ts b/src/components/hooks/queries/useWebsiteMetrics.tsnew file mode 100644index 000000000..c7a719b12--- /dev/null+++ b/src/components/hooks/queries/useWebsiteMetrics.ts@@ -0,0 +1,34 @@+import useApi from './useApi';+import { UseQueryOptions } from '@tanstack/react-query';++export function useWebsiteMetrics(+ websiteId: string,+ params?: { [key: string]: any },+ options?: Omit<UseQueryOptions, 'queryKey' | 'queryFn'>,+) {+ const { get, useQuery } = useApi();++ return useQuery({+ queryKey: [+ 'websites:metrics',+ {+ websiteId,+ ...params,+ },+ ],+ queryFn: async () => {+ const filters = { ...params };++ filters[params.type] = undefined;++ const data = await get(`/websites/${websiteId}/metrics`, {+ ...filters,+ });++ return data;+ },+ ...options,+ });+}++export default useWebsiteMetrics;diff --git a/src/components/metrics/EventsChart.tsx b/src/components/metrics/EventsChart.tsxindex d4f85ed72..b1c581fce 100644--- a/src/components/metrics/EventsChart.tsx+++ b/src/components/metrics/EventsChart.tsx@@ -3,7 +3,13 @@ import { Loading } from 'react-basics';import { colord } from 'colord';import BarChart from './BarChart';import { getDateArray } from 'lib/date';-import { useApi, useLocale, useDateRange, useTimezone, useNavigation } from 'components/hooks';+import {+ useLocale,+ useDateRange,+ useTimezone,+ useNavigation,+ useWebsiteEvents,+} from 'components/hooks';import { EVENT_COLORS } from 'lib/constants';import { renderDateLabels, renderStatusTooltipPopup } from 'lib/charts';@@ -14,34 +20,29 @@ export interface EventsChartProps {}export function EventsChart({ websiteId, className, token }: EventsChartProps) {- const { get, useQuery } = useApi();- const [{ startDate, endDate, unit, modified }] = useDateRange(websiteId);+ const [{ startDate, endDate, unit, offset }] = useDateRange(websiteId);const { locale } = useLocale();const [timezone] = useTimezone();const {query: { url, event },} = useNavigation();- const { data, isLoading } = useQuery({- queryKey: ['events', websiteId, modified, event],- queryFn: () =>- get(`/websites/${websiteId}/events`, {- startAt: +startDate,- endAt: +endDate,- unit,- timezone,- url,- event,- token,- }),- enabled: !!websiteId,+ const { data, isLoading } = useWebsiteEvents(websiteId, {+ startAt: +startDate,+ endAt: +endDate,+ unit,+ timezone,+ url,+ event,+ token,+ offset,});const datasets = useMemo(() => {if (!data) return [];if (isLoading) return data;- const map = data.reduce((obj, { x, t, y }) => {+ const map = (data as any[]).reduce((obj, { x, t, y }) => {if (!obj[x]) {obj[x] = [];}@@ -75,7 +76,7 @@ export function EventsChart({ websiteId, className, token }: EventsChartProps) {return (<BarChartclassName={className}- datasets={datasets}+ datasets={datasets as any[]}unit={unit}stacked={true}renderXLabel={renderDateLabels(unit, locale)}diff --git a/src/components/metrics/MetricsTable.tsx b/src/components/metrics/MetricsTable.tsxindex 79e4d3397..19d3e7fc2 100644--- a/src/components/metrics/MetricsTable.tsx+++ b/src/components/metrics/MetricsTable.tsx@@ -1,7 +1,6 @@import { ReactNode, useMemo, useState } from 'react';import { Loading, Icon, Text, SearchField } from 'react-basics';import classNames from 'classnames';-import { useApi } from 'components/hooks';import { percentFilter } from 'lib/filters';import { useDateRange } from 'components/hooks';import { useNavigation } from 'components/hooks';@@ -14,6 +13,7 @@ import { useMessages } from 'components/hooks';import { useLocale } from 'components/hooks';import useFormat from 'components//hooks/useFormat';import styles from './MetricsTable.module.css';+import useWebsiteMetrics from 'components/hooks/queries/useWebsiteMetrics';export interface MetricsTableProps extends ListTableProps {websiteId: string;@@ -43,55 +43,36 @@ export function MetricsTable({}: MetricsTableProps) {const [search, setSearch] = useState('');const { formatValue } = useFormat();- const [{ startDate, endDate, modified }] = useDateRange(websiteId);+ const [{ startDate, endDate }] = useDateRange(websiteId);const {renderUrl,query: { url, referrer, title, os, browser, device, country, region, city },} = useNavigation();const { formatMessage, labels } = useMessages();- const { get, useQuery } = useApi();const { dir } = useLocale();- const { data, isLoading, isFetched, error } = useQuery({- queryKey: [- 'websites:metrics',- {- websiteId,- type,- modified,- url,- referrer,- os,- title,- browser,- device,- country,- region,- city,- },- ],- queryFn: async () => {- const filters = { url, title, referrer, os, browser, device, country, region, city };- filters[type] = undefined;-- const data = await get(`/websites/${websiteId}/metrics`, {- type,- startAt: +startDate,- endAt: +endDate,- limit,- ...filters,- });-- onDataLoad?.(data);-- return data;+ const { data, isLoading, isFetched, error } = useWebsiteMetrics(+ websiteId,+ {+ type,+ startAt: +startDate,+ endAt: +endDate,+ url,+ referrer,+ os,+ title,+ browser,+ device,+ country,+ region,+ city,},- retryDelay: delay || DEFAULT_ANIMATION_DURATION,- });+ { retryDelay: delay || DEFAULT_ANIMATION_DURATION },+ );const filteredData = useMemo(() => {if (data) {- let items: any[] = data;+ let items = data as any[];if (dataFilter) {if (Array.isArray(dataFilter)) {