📈 Open source, privacy-first web analytics — a cookie-less Google Analytics alternative with built-in error tracking and performance monitoring. Self-host it or use our cloud. Get started for free!
TypeScript chartsclickhousedockergdprgoogle-analyticsmetricsmonitoringmysqlnestjsprivacyredisself-hostedselfhostedstatisticstailwindcssweb-analyticswebanalyticswebsite
(feature) Events metadata (#372)
Andrii Romasiun166f27aec8d6
diff --git a/app/api/index.ts b/app/api/index.tsindex 21975c830..00d98131f 100644--- a/app/api/index.ts+++ b/app/api/index.ts@@ -434,6 +434,33 @@ export const getProjectData = (: error.response.data.message})+export const getCustomEventsMetadata = (+ pid: string,+ event: string,+ tb: string = 'hour',+ period: string = '1d',+ from: string = '',+ to: string = '',+ timezone: string = '',+ password: string | undefined = '',+) =>+ api+ .get(+ `log/meta?pid=${pid}&timeBucket=${tb}&period=${period}&from=${from}&to=${to}&timezone=${timezone}&event=${event}`,+ {+ headers: {+ 'x-password': password,+ },+ },+ )+ .then((response) => response.data)+ .catch((error) => {+ debug('%s', error)+ throw _isEmpty(error.response.data?.message)+ ? error.response.data+ : error.response.data.message+ })+export const getProjectCompareData = (pid: string,tb: string = 'hour',@@ -1163,7 +1190,7 @@ export const getBlogPost = (slug: string) =>throw error})-export const getSitemap = () =>+export const getSitemap = () =>api.get('v1/blog/sitemap').then((response) => response.data)@@ -1194,4 +1221,3 @@ export const getLastPost = () =>? error.response.data: error.response.data.message})-\ No newline at end of filediff --git a/app/pages/Changelog/index.tsx b/app/pages/Changelog/index.tsxindex 007ed6754..edaaedd44 100644--- a/app/pages/Changelog/index.tsx+++ b/app/pages/Changelog/index.tsx@@ -14,6 +14,20 @@ const INTEGRATIONS_LINK = `${routes.user_settings}#integrations`// Date format: YYYY-MM-DDconst changelog = [+ {+ date: '2023-10-14',+ changes: [+ 'Added custom events metadata feature.',+ 'Reworked the plan usage section on the billing page.',+ 'Reworked billing page, added a lot of new tiers',+ 'Reworked auth pages.',+ 'Added alerts for custom events.',+ 'Rewritten and moved blog from a separate domain to the main domain.',+ 'Fixed an issue which caused unclickable "Shared projects" tab on mobile devices for account that have no shared projects.',+ 'Added Admin API.',+ 'And a lot of other small improvements and fixes.',+ ],+ },{date: '2023-07-22',changes: [diff --git a/app/pages/Project/View/Panels.tsx b/app/pages/Project/View/Panels.tsxindex 44cd3709b..cd8d3424e 100644--- a/app/pages/Project/View/Panels.tsx+++ b/app/pages/Project/View/Panels.tsx@@ -31,15 +31,15 @@ import _sortBy from 'lodash/sortBy'import _fromPairs from 'lodash/fromPairs'import _toPairs from 'lodash/toPairs'import _reverse from 'lodash/reverse'-import { nFormatter } from 'utils/generic'+import { nFormatter } from 'utils/generic'import Progress from 'ui/Progress'import PulsatingCircle from 'ui/icons/PulsatingCircle'import Sort from 'ui/icons/Sort'import Modal from 'ui/Modal'import Button from 'ui/Button'import Chart from 'ui/Chart'-+import Loader from 'ui/Loader'import { PROJECT_TABS } from 'redux/constants'import { IEntry } from 'redux/models/IEntry'import LiveVisitorsDropdown from './components/LiveVisitorsDropdown'@@ -101,7 +101,7 @@ interface IPanelContainer {noSwitch?: boolean,icon?: React.ReactNode,type: string,- openModal?: () => void,+ onExpandClick?: () => void,activeFragment: number | string,setActiveFragment: (arg: number) => void,customTabs?: any,@@ -111,7 +111,8 @@ interface IPanelContainer {// noSwitch - 'previous' and 'next' buttonsconst PanelContainer = ({- name, children, noSwitch, icon, type, openModal, activeFragment, setActiveFragment, customTabs, activeTab, isCustomContent,+ name, children, noSwitch, icon, type, activeFragment, setActiveFragment,+ customTabs, activeTab, isCustomContent, onExpandClick,}: IPanelContainer): JSX.Element => (<divclassName={cx('relative bg-white dark:bg-slate-800/25 dark:border dark:border-slate-800/50 pt-5 px-4 min-h-72 max-h-96 sm:pt-6 sm:px-6 shadow rounded-lg overflow-hidden', {@@ -154,7 +155,7 @@ const PanelContainer = ({className={cx(iconClassName, 'ml-2 cursor-pointer text-slate-400 dark:text-slate-500', {hidden: activeFragment === 0,})}- onClick={openModal}+ onClick={onExpandClick}/></>)}@@ -172,7 +173,7 @@ const PanelContainer = ({className={cx(iconClassName, 'ml-2 cursor-pointer text-slate-400 dark:text-slate-500', {hidden: activeFragment === 0,})}- onClick={openModal}+ onClick={onExpandClick}/></>)}@@ -187,6 +188,17 @@ const PanelContainer = ({onClick={() => setActiveFragment(1)}/>)}++ {/* if it is a 'Custom events' tab */}+ {type === 'ce' && (+ <>+ <ArrowsPointingOutIcon+ className={cx(iconClassName, 'ml-2 cursor-pointer text-slate-400 dark:text-slate-500')}+ onClick={onExpandClick}+ />+ </>+ )}+{checkCustomTabs(type, customTabs) && (<>{/* This is a temp fix to prevent multiple tabs of the same extensionID be displayed */}@@ -235,6 +247,7 @@ PanelContainer.propTypes = {noSwitch: PropTypes.bool,activeFragment: PropTypes.oneOfType([PropTypes.number, PropTypes.string]),setActiveFragment: PropTypes.func,+ onExpandClick: PropTypes.func,icon: PropTypes.node,}@@ -243,7 +256,7 @@ PanelContainer.defaultProps = {noSwitch: false,activeFragment: 0,setActiveFragment: () => { },- openModal: () => { },+ onExpandClick: () => { },customTabs: [],activeTab: '',isCustomContent: false,@@ -284,7 +297,7 @@ const Overview = ({}return (- <PanelContainer name={t('project.overview')} noSwitch type='' openModal={() => {}}>+ <PanelContainer name={t('project.overview')} type='overview' noSwitch><div className='flex text-lg justify-between'><div className='flex items-center dark:text-gray-50'><PulsatingCircle className='mr-1.5' type='big' />@@ -302,12 +315,12 @@ const Overview = ({{activePeriod.label}</span>{isActiveCompare && (- // return vs activeDropdownLabelCompare- <span className='text-sm text-gray-500 dark:text-gray-400'>+ // return vs activeDropdownLabelCompare+ <span className='text-sm text-gray-500 dark:text-gray-400'> (- {activeDropdownLabelCompare}- )- </span>+ {activeDropdownLabelCompare}+ )+ </span>)}</p>@@ -519,6 +532,7 @@ interface ICustomEvents {chartData: anyonFilter: anyt: (arg0: string) => string+ getCustomEventMetadata: (event: string) => anycustomTabs: any}@@ -528,11 +542,101 @@ interface ISortRows {sortByDescend: boolean}+interface IKVTable {+ data: any+ t: any+ uniques: number+ loading: boolean+}++const KVTable = ({+ data, t, uniques, loading,+}: IKVTable) => {+ const processed = useMemo(() => {+ return _reduce(data, (acc: any, curr: any) => {+ if (!acc[curr.key]) {+ acc[curr.key] = []+ }++ acc[curr.key].push({+ value: curr.value,+ count: curr.count,+ })++ return acc+ }, {})+ }, [data])++ if (loading) {+ return (+ <div className='flex justify-center items-center pt-5 pb-10 w-full'>+ <Loader />+ </div>+ )+ }++ if (_isEmpty(data)) {+ return (+ <p className='text-gray-600 dark:text-gray-200 mb-2'>+ No data to display+ </p>+ )+ }++ return _map(processed, (value, key) => {+ return (+ <table key={key} className='table-fixed w-full mb-2'>+ <thead>+ <tr className='text-gray-600 dark:text-gray-200'>+ <th className='w-2/5 sm:w-4/6 text-left flex items-center'>+ {key}+ </th>+ <th className='w-[30%] sm:w-1/6'>+ <p className='flex justify-end items-center'>+ {t('project.quantity')}+ </p>+ </th>+ <th className='w-[30%] sm:w-1/6'>+ <p className='flex justify-end items-center'>+ {t('project.conversion')}+ </p>+ </th>+ </tr>+ </thead>+ <tbody>+ {_map(value, ({ value: nestedValue, count }) => (+ <tr+ key={nestedValue}+ className='text-gray-900 dark:text-gray-50 group hover:bg-gray-100 hover:dark:bg-slate-700 py-3'+ >+ <td className='text-left flex items-center'>+ {nestedValue}+ </td>+ <td className='text-right'>+ {count}+ + </td>+ <td className='text-right'>+ {uniques === 0 ? 100 : _round((count / uniques) * 100, 2)}+ %+ </td>+ </tr>+ ))}+ </tbody>+ </table>+ )+ })+}+// Tabs with custom events like submit form, press button, go to the link rate etc.const CustomEvents = ({- customs, chartData, onFilter, t, customTabs,+ customs, chartData, onFilter, t, customTabs, getCustomEventMetadata,}: ICustomEvents) => {const [page, setPage] = useState(0)+ const [modal, setModal] = useState(false)+ const [activeEvents, setActiveEvents] = useState<any>({})+ const [loadingEvents, setLoadingEvents] = useState<any>({})+ const [eventsMetadata, setEventsMetadata] = useState<any>({})const [customsEventsData, setCustomsEventsData] = useState<any>(customs)const currentIndex = page * ENTRIES_PER_CUSTOM_EVENTS_PANELconst keys = _keys(customsEventsData)@@ -602,6 +706,47 @@ const CustomEvents = ({}))}+ const toggleEventMetadata = (ev: string) => async (e: any) => {+ e.stopPropagation()++ setActiveEvents((events: any) => ({+ ...events,+ [ev]: !events[ev],+ }))++ if (!eventsMetadata[ev]) {+ setLoadingEvents((events: any) => ({+ ...events,+ [ev]: true,+ }))++ try {+ const data = await getCustomEventMetadata(ev)+ setEventsMetadata((metadata: any) => ({+ ...metadata,+ [ev]: data,+ }))+ } catch (reason) {+ console.error(`[ERROR](toggleEventMetadata) Failed to get metadata for event ${ev}`, reason)+ setEventsMetadata((metadata: any) => ({+ ...metadata,+ [ev]: [],+ }))+ }++ setLoadingEvents((events: any) => ({+ ...events,+ [ev]: false,+ }))+ }+ }++ const onModalClose = () => {+ setModal(false)+ setActiveEvents({})+ setEventsMetadata({})+ }+const onSortBy = (label: string) => {const sortByKeys = label === 'event'@@ -654,6 +799,7 @@ const CustomEvents = ({type='ce'setActiveFragment={setActiveFragment}activeFragment={activeFragment}+ onExpandClick={() => setModal(true)}>{_isEmpty(chartData) ? (<p className='mt-1 text-base text-gray-700 dark:text-gray-300'>@@ -665,6 +811,95 @@ const CustomEvents = ({current='panels-ce'/>)}+ <Modal+ onClose={onModalClose}+ isOpened={modal}+ title={t('project.customEv')}+ message={(+ <table className='table-fixed w-full'>+ <thead>+ <tr className='text-gray-900 dark:text-gray-50 text-base'>+ <th className='w-2/5 sm:w-4/6 text-left flex items-center cursor-pointer hover:opacity-90' onClick={() => onSortBy('event')}>+ {t('project.event')}+ <Sort+ className='ml-1'+ sortByAscend={sort.label === 'event' && sort.sortByAscend}+ sortByDescend={sort.label === 'event' && sort.sortByDescend}+ />+ </th>+ <th className='w-[30%] sm:w-1/6'>+ <p className='flex justify-end items-center cursor-pointer hover:opacity-90' onClick={() => onSortBy('quantity')}>+ {t('project.quantity')}+ <Sort+ className='ml-1'+ sortByAscend={sort.label === 'quantity' && sort.sortByAscend}+ sortByDescend={sort.label === 'quantity' && sort.sortByDescend}+ />+ + </p>+ </th>+ <th className='w-[30%] sm:w-1/6'>+ <p className='flex justify-end items-center cursor-pointer hover:opacity-90' onClick={() => onSortBy('conversion')}>+ {t('project.conversion')}+ <Sort+ className='ml-1'+ sortByAscend={sort.label === 'conversion' && sort.sortByAscend}+ sortByDescend={sort.label === 'conversion' && sort.sortByDescend}+ />+ </p>+ </th>+ </tr>+ </thead>+ <tbody>+ {_map(keysToDisplay, (ev) => (+ <Fragment key={ev}>+ <tr+ className='text-gray-900 dark:text-gray-50 group hover:bg-gray-100 hover:dark:bg-slate-700 cursor-pointer text-base py-1'+ onClick={() => onFilter('ev', ev)}+ >+ <td className='text-left flex items-center'>+ {activeEvents[ev] ? (+ <ChevronUpIcon+ className='w-auto h-5 text-gray-500 dark:text-gray-300 px-2 hover:opacity-80'+ onClick={toggleEventMetadata(ev)}+ />+ ) : (+ <ChevronDownIcon+ className='w-auto h-5 text-gray-500 dark:text-gray-300 px-2 hover:opacity-80'+ onClick={toggleEventMetadata(ev)}+ />+ )}+ {ev}+ <FunnelIcon className='ml-2 w-4 h-4 text-gray-500 hidden sm:group-hover:block dark:text-gray-300' />+ </td>+ <td className='text-right'>+ {customsEventsData[ev]}+ + </td>+ <td className='text-right'>+ {uniques === 0 ? 100 : _round((customsEventsData[ev] / uniques) * 100, 2)}+ %+ </td>+ </tr>+ {activeEvents[ev] && (+ <tr>+ <td className='pl-9' colSpan={3}>+ <KVTable+ data={eventsMetadata[ev]}+ t={t}+ uniques={uniques}+ loading={loadingEvents[ev]}+ />+ </td>+ </tr>+ )}+ </Fragment>+ ))}+ </tbody>+ </table>+ )}+ size='large'+ /></PanelContainer>)}@@ -683,6 +918,7 @@ const CustomEvents = ({activeFragment={activeFragment}setActiveFragment={setActiveFragment}customTabs={customTabs}+ onExpandClick={() => { }}isCustomContent>{/* Using this instead of dangerouslySetInnerHTML to support script tags */}@@ -694,7 +930,14 @@ const CustomEvents = ({}return (- <PanelContainer customTabs={customTabs} name={t('project.customEv')} type='ce' setActiveFragment={setActiveFragment} activeFragment={activeFragment}>+ <PanelContainer+ customTabs={customTabs}+ name={t('project.customEv')}+ type='ce'+ setActiveFragment={setActiveFragment}+ activeFragment={activeFragment}+ onExpandClick={() => setModal(true)}+ ><table className='table-fixed'><thead><tr className='text-gray-900 dark:text-gray-50'>@@ -807,6 +1050,95 @@ const CustomEvents = ({</div></div>)}+ <Modal+ onClose={onModalClose}+ isOpened={modal}+ title={t('project.customEv')}+ message={(+ <table className='table-fixed w-full'>+ <thead>+ <tr className='text-gray-900 dark:text-gray-50 text-base'>+ <th className='w-2/5 sm:w-4/6 text-left flex items-center cursor-pointer hover:opacity-90' onClick={() => onSortBy('event')}>+ {t('project.event')}+ <Sort+ className='ml-1'+ sortByAscend={sort.label === 'event' && sort.sortByAscend}+ sortByDescend={sort.label === 'event' && sort.sortByDescend}+ />+ </th>+ <th className='w-[30%] sm:w-1/6'>+ <p className='flex justify-end items-center cursor-pointer hover:opacity-90' onClick={() => onSortBy('quantity')}>+ {t('project.quantity')}+ <Sort+ className='ml-1'+ sortByAscend={sort.label === 'quantity' && sort.sortByAscend}+ sortByDescend={sort.label === 'quantity' && sort.sortByDescend}+ />+ + </p>+ </th>+ <th className='w-[30%] sm:w-1/6'>+ <p className='flex justify-end items-center cursor-pointer hover:opacity-90' onClick={() => onSortBy('conversion')}>+ {t('project.conversion')}+ <Sort+ className='ml-1'+ sortByAscend={sort.label === 'conversion' && sort.sortByAscend}+ sortByDescend={sort.label === 'conversion' && sort.sortByDescend}+ />+ </p>+ </th>+ </tr>+ </thead>+ <tbody>+ {_map(keysToDisplay, (ev) => (+ <Fragment key={ev}>+ <tr+ className='text-gray-900 dark:text-gray-50 group hover:bg-gray-100 hover:dark:bg-slate-700 cursor-pointer text-base py-1'+ onClick={() => onFilter('ev', ev)}+ >+ <td className='text-left flex items-center'>+ {activeEvents[ev] ? (+ <ChevronUpIcon+ className='w-auto h-5 text-gray-500 dark:text-gray-300 px-2 hover:opacity-80'+ onClick={toggleEventMetadata(ev)}+ />+ ) : (+ <ChevronDownIcon+ className='w-auto h-5 text-gray-500 dark:text-gray-300 px-2 hover:opacity-80'+ onClick={toggleEventMetadata(ev)}+ />+ )}+ {ev}+ <FunnelIcon className='ml-2 w-4 h-4 text-gray-500 hidden sm:group-hover:block dark:text-gray-300' />+ </td>+ <td className='text-right'>+ {customsEventsData[ev]}+ + </td>+ <td className='text-right'>+ {uniques === 0 ? 100 : _round((customsEventsData[ev] / uniques) * 100, 2)}+ %+ </td>+ </tr>+ {activeEvents[ev] && (+ <tr>+ <td className='pl-9' colSpan={3}>+ <KVTable+ data={eventsMetadata[ev]}+ t={t}+ uniques={uniques}+ loading={loadingEvents[ev]}+ />+ </td>+ </tr>+ )}+ </Fragment>+ ))}+ </tbody>+ </table>+ )}+ size='large'+ /></PanelContainer>)}@@ -908,7 +1240,7 @@ const Panel = ({type={id}activeFragment={activeFragment}setActiveFragment={_setActiveFragment}- openModal={() => setModal(true)}+ onExpandClick={() => setModal(true)}customTabs={customTabs}><InteractiveMap@@ -942,7 +1274,7 @@ const Panel = ({type={id}activeFragment={activeFragment}setActiveFragment={_setActiveFragment}- openModal={() => setModal(true)}+ onExpandClick={() => setModal(true)}customTabs={customTabs}>{/* @ts-ignore */}@@ -1071,7 +1403,7 @@ const Panel = ({type={id}activeFragment={activeFragment}setActiveFragment={_setActiveFragment}- openModal={() => setModal(true)}+ onExpandClick={() => setModal(true)}customTabs={customTabs}activeTab={activeTab}isCustomContentdiff --git a/app/pages/Project/View/ViewProject.tsx b/app/pages/Project/View/ViewProject.tsxindex b4e1c0df8..b9371396b 100644--- a/app/pages/Project/View/ViewProject.tsx+++ b/app/pages/Project/View/ViewProject.tsx@@ -65,7 +65,8 @@ import routes from 'routesPath'import Header from 'components/Header'import Footer from 'components/Footer'import {- getProjectData, getProject, getOverallStats, getLiveVisitors, getPerfData, getProjectDataCustomEvents, getProjectCompareData, checkPassword,+ getProjectData, getProject, getOverallStats, getLiveVisitors, getPerfData, getProjectDataCustomEvents,+ getProjectCompareData, checkPassword, getCustomEventsMetadata,} from 'api'import { getChartPrediction } from 'api/ai'import {@@ -857,6 +858,14 @@ const ViewProject = ({}}+ const getCustomEventMetadata = async (event: string) => {+ if (period === 'custom' && dateRange) {+ return getCustomEventsMetadata(id, event, timeBucket, '', getFormatDate(dateRange[0]), getFormatDate(dateRange[1]), timezone, projectPassword)+ }++ return getCustomEventsMetadata(id, event, timeBucket, period, '', '', timezone, projectPassword)+ }+// similar to loadAnalytics but using for performance tabconst loadAnalyticsPerf = async (forced = false, newFilters: any[] | null = null) => {if (!forced && (isLoading || _isEmpty(project) || dataLoading)) {@@ -2507,6 +2516,7 @@ const ViewProject = ({onFilter={filterHandler}chartData={chartData}customTabs={_filter(customPanelTabs, tab => tab.panelID === 'ce')}+ getCustomEventMetadata={getCustomEventMetadata}/>)}</div>diff --git a/app/ui/Modal.tsx b/app/ui/Modal.tsxindex eb168f808..6b1d6130e 100644--- a/app/ui/Modal.tsx+++ b/app/ui/Modal.tsx@@ -3,7 +3,7 @@ import PropTypes from 'prop-types'import cx from 'clsx'import { Dialog, Transition } from '@headlessui/react'import {- CheckIcon, ExclamationTriangleIcon, InformationCircleIcon, UserGroupIcon,+ CheckIcon, ExclamationTriangleIcon, InformationCircleIcon, UserGroupIcon, XMarkIcon,} from '@heroicons/react/24/outline'import Beta from 'ui/Beta'import Spin from './icons/Spin'@@ -26,7 +26,8 @@ interface IModal {}const Modal = ({- className, type, title, message, isOpened, onClose, onSubmit, closeText, submitText, submitType, size, customButtons, isBeta, isLoading,+ className, type, title, message, isOpened, onClose, onSubmit, closeText, submitText,+ submitType, size, customButtons, isBeta, isLoading,}: IModal): JSX.Element => (<Transition.Root show={isOpened} as={Fragment}><Dialog@@ -96,10 +97,24 @@ const Modal = ({)}<div className='mt-3 text-center sm:mt-0 sm:text-left w-full'>{title && (- <Dialog.Title as='h3' className='flex items-center justify-center sm:justify-start text-lg leading-6 font-medium text-gray-900 dark:text-gray-50'>- {title}- {isBeta && (- <Beta className='ml-10' />+ <Dialog.Title+ as='h3'+ className={cx('flex items-center text-lg leading-6 font-medium text-gray-900 dark:text-gray-50', {+ 'justify-between': !closeText,+ 'justify-center sm:justify-start': closeText,+ })}+ >+ <div>+ {title}+ {isBeta && (+ <Beta className='ml-10' />+ )}+ </div>+ {!closeText && (+ <XMarkIcon+ className='h-6 w-6 cursor-pointer text-gray-700 dark:text-gray-200 hover:text-gray-500 dark:hover:text-gray-300'+ onClick={onClose}+ />)}</Dialog.Title>)}diff --git a/public/locales/en.json b/public/locales/en.jsonindex cc92178f8..140f054ee 100644--- a/public/locales/en.json+++ b/public/locales/en.json@@ -580,6 +580,7 @@"weeklyStats": "Weekly stats","statsFor": "Stats for","event": "Event",+ "value": "Value","quantity": "Quantity","conversion": "Conversion","ratio": "Ratio",