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
Dashboard Pages v2 (#6262)
RobertJoonas515ff9edc246
diff --git a/assets/js/dashboard/api.ts b/assets/js/dashboard/api.tsindex d51aa2ae80..91e76fab66 100644--- a/assets/js/dashboard/api.ts+++ b/assets/js/dashboard/api.ts@@ -1,4 +1,4 @@-import { Metric } from '../types/query-api'+import { Metric } from './stats/metrics'import { DashboardState } from './dashboard-state'import { PlausibleSite } from './site-context'import { StatsQuery } from './stats-query'@@ -9,18 +9,38 @@ import * as url from './util/url'let abortController = new AbortController()let SHARED_LINK_AUTH: null | string = null+export type RevenueMetricValue = {+ short: string+ value: number+ long: string+ currency: string+}++export type MetricValue = null | number | RevenueMetricValue++export type QueryResultQuery = {+ metrics: Metric[]+ dimensions: string[]+ date_range: [string, string]+ comparison_date_range?: [string, string] | null+}++export type QueryResultMeta = {+ metric_warnings?: Record<string, Record<string, string>>+ imports_included?: boolean+ imports_skip_reason?: string+}++export type QueryResultRow = {+ metrics: Array<MetricValue>+ dimensions: Array<string>+ comparison?: { metrics: Array<number>; change: Array<number> }+}+export type QueryApiResponse = {- query: {- metrics: Metric[]- date_range: [string, string]- comparison_date_range: [string, string]- }- meta: Record<string, unknown>- results: {- metrics: Array<number>- dimensions: Array<string>- comparison: { metrics: Array<number>; change: Array<number> }- }[]+ query: QueryResultQuery+ meta: QueryResultMeta+ results: QueryResultRow[]}export class ApiError extends Error {diff --git a/assets/js/dashboard/components/sort-button.tsx b/assets/js/dashboard/components/sort-button.tsxindex 3ca98b298c..3c1e2c4952 100644--- a/assets/js/dashboard/components/sort-button.tsx+++ b/assets/js/dashboard/components/sort-button.tsx@@ -1,5 +1,5 @@import React, { ReactNode } from 'react'-import { cycleSortDirection, SortDirection } from '../hooks/use-order-by'+import { cycleSortDirection, SortDirection } from '../hooks/use-order-by-legacy'import classNames from 'classnames'export const SortButton = ({diff --git a/assets/js/dashboard/components/table-legacy.tsx b/assets/js/dashboard/components/table-legacy.tsxnew file mode 100644index 0000000000..7460fb26a2--- /dev/null+++ b/assets/js/dashboard/components/table-legacy.tsx@@ -0,0 +1,216 @@+import classNames from 'classnames'+import React, { ReactNode } from 'react'+import { SortDirection } from '../hooks/use-order-by-legacy'+import { SortButton } from './sort-button'+import { Tooltip } from '../util/tooltip'++export type ColumnConfiguraton<T extends Record<string, unknown>> = {+ /** Unique column ID, used for sorting purposes and to get the value of the cell using rowItem[key] */+ key: keyof T+ /** Column title */+ label: string+ /** If defined, the column is considered sortable. @see SortButton */+ onSort?: () => void+ sortDirection?: SortDirection+ /** CSS class string. @example "w-24 md:w-32" */+ width: string+ /** Aligns column content. */+ align?: 'left' | 'right'+ /** A warning to be rendered as a tooltip for the column header */+ metricWarning?: string+ /**+ * Function used to transform the value found at item[key] for the cell. Superseded by renderItem if present. @example 1120 => "1.1k"+ */+ renderValue?: (item: T, isRowHovered?: boolean) => ReactNode+ /** Function used to create richer cells */+ renderItem?: (item: T) => ReactNode+}++export const TableHeaderCell = ({+ children,+ className,+ align+}: {+ children: ReactNode+ className: string+ align?: 'left' | 'right'+}) => {+ return (+ <th+ data-testid="report-header"+ className={classNames(+ 'p-2 text-xs font-semibold text-gray-500 dark:text-gray-400',+ className+ )}+ align={align}+ >+ {children}+ </th>+ )+}++export const TableCell = ({+ children,+ className,+ align+}: {+ children: ReactNode+ className: string+ align?: 'left' | 'right'+}) => {+ return (+ <td+ className={classNames(+ 'p-2 font-medium first:rounded-s-sm last:rounded-e-sm',+ className+ )}+ align={align}+ >+ {children}+ </td>+ )+}++export const ItemRow = <T extends Record<string, string | number | ReactNode>>({+ rowIndex,+ pageIndex,+ item,+ columns,+ tappedRowName,+ onRowTap+}: {+ rowIndex: number+ pageIndex?: number+ item: T+ columns: ColumnConfiguraton<T>[]+ tappedRowName?: string | null+ onRowTap?: (rowName: string | null) => void+}) => {+ const [isHovered, setIsHovered] = React.useState(false)++ const rowName = (item as unknown as { name: string }).name+ const isTapped = tappedRowName === rowName+ const isRowActive = isHovered || isTapped++ const handleRowClick = (e: React.MouseEvent) => {+ if (window.innerWidth < 768 && !(e.target as HTMLElement).closest('a')) {+ if (onRowTap) {+ if (isTapped) {+ onRowTap(null)+ } else {+ onRowTap(rowName)+ }+ }+ }+ }++ return (+ <tr+ data-testid="report-row"+ className="group text-sm dark:text-gray-200 md:cursor-default cursor-pointer"+ onMouseEnter={() => setIsHovered(true)}+ onMouseLeave={() => setIsHovered(false)}+ onClick={handleRowClick}+ >+ {columns.map(({ key, width, align, renderValue, renderItem }) => (+ <TableCell+ key={`${(pageIndex ?? null) === null ? '' : `page_${pageIndex}_`}row_${rowIndex}_${String(key)}`}+ className={width}+ align={align}+ >+ {renderItem+ ? renderItem(item)+ : renderValue+ ? renderValue(item, isRowActive)+ : (item[key] ?? '')}+ </TableCell>+ ))}+ </tr>+ )+}++export const Table = <T extends Record<string, string | number | ReactNode>>({+ data,+ columns+}: {+ columns: ColumnConfiguraton<T>[]+ data: T[] | { pages: T[][] }+}) => {+ const [tappedRowName, setTappedRowName] = React.useState<string | null>(null)++ const renderColumnLabel = (column: ColumnConfiguraton<T>) => {+ if (column.metricWarning) {+ return (+ <Tooltip+ info={warningSpan(column.metricWarning)}+ className="inline-block"+ >+ {column.label + ' *'}+ </Tooltip>+ )+ } else {+ return column.label+ }+ }++ const warningSpan = (warning: string) => {+ return (+ <span className="text-xs font-normal whitespace-nowrap">+ {'* ' + warning}+ </span>+ )+ }++ return (+ <table className="border-collapse table-striped table-fixed w-max min-w-full">+ <thead className="sticky top-0 bg-white dark:bg-gray-900 z-10">+ <tr className="text-xs font-semibold text-gray-500 dark:text-gray-400">+ {columns.map((column) => (+ <TableHeaderCell+ key={`header_${String(column.key)}`}+ className={classNames('p-2', column.width)}+ align={column.align}+ >+ {column.onSort ? (+ <SortButton+ toggleSort={column.onSort}+ sortDirection={column.sortDirection ?? null}+ >+ {renderColumnLabel(column)}+ </SortButton>+ ) : (+ renderColumnLabel(column)+ )}+ </TableHeaderCell>+ ))}+ </tr>+ </thead>+ <tbody>+ {Array.isArray(data)+ ? data.map((item, rowIndex) => (+ <ItemRow+ item={item}+ columns={columns}+ rowIndex={rowIndex}+ key={rowIndex}+ tappedRowName={tappedRowName}+ onRowTap={setTappedRowName}+ />+ ))+ : data.pages.map((page, pageIndex) =>+ page.map((item, rowIndex) => (+ <ItemRow+ item={item}+ columns={columns}+ rowIndex={rowIndex}+ pageIndex={pageIndex}+ key={`page_${pageIndex}_row_${rowIndex}`}+ tappedRowName={tappedRowName}+ onRowTap={setTappedRowName}+ />+ ))+ )}+ </tbody>+ </table>+ )+}diff --git a/assets/js/dashboard/components/table.tsx b/assets/js/dashboard/components/table.tsxindex ba9116193e..7c2cf54bad 100644--- a/assets/js/dashboard/components/table.tsx+++ b/assets/js/dashboard/components/table.tsx@@ -1,106 +1,27 @@import classNames from 'classnames'-import React, { ReactNode } from 'react'-import { SortDirection } from '../hooks/use-order-by'-import { SortButton } from './sort-button'-import { Tooltip } from '../util/tooltip'+import React, { useState } from 'react'+import { ColumnConfiguration } from '../stats/breakdowns'-export type ColumnConfiguraton<T extends Record<string, unknown>> = {- /** Unique column ID, used for sorting purposes and to get the value of the cell using rowItem[key] */- key: keyof T- /** Column title */- label: string- /** If defined, the column is considered sortable. @see SortButton */- onSort?: () => void- sortDirection?: SortDirection- /** CSS class string. @example "w-24 md:w-32" */- width: string- /** Aligns column content. */- align?: 'left' | 'right'- /** A warning to be rendered as a tooltip for the column header */- metricWarning?: string- /**- * Function used to transform the value found at item[key] for the cell. Superseded by renderItem if present. @example 1120 => "1.1k"- */- renderValue?: (item: T, isRowHovered?: boolean) => ReactNode- /** Function used to create richer cells */- renderItem?: (item: T) => ReactNode-}--export const TableHeaderCell = ({- children,- className,- align-}: {- children: ReactNode- className: string- align?: 'left' | 'right'-}) => {- return (- <th- data-testid="report-header"- className={classNames(- 'p-2 text-xs font-semibold text-gray-500 dark:text-gray-400',- className- )}- align={align}- >- {children}- </th>- )-}--export const TableCell = ({- children,- className,- align-}: {- children: ReactNode- className: string- align?: 'left' | 'right'-}) => {- return (- <td- className={classNames(- 'p-2 font-medium first:rounded-s-sm last:rounded-e-sm',- className- )}- align={align}- >- {children}- </td>- )-}--export const ItemRow = <T extends Record<string, string | number | ReactNode>>({- rowIndex,- pageIndex,- item,+function Row<T>({+ row,columns,- tappedRowName,- onRowTap+ rowKey,+ tappedKey,+ onTap}: {- rowIndex: number- pageIndex?: number- item: T- columns: ColumnConfiguraton<T>[]- tappedRowName?: string | null- onRowTap?: (rowName: string | null) => void-}) => {- const [isHovered, setIsHovered] = React.useState(false)+ row: T+ columns: ColumnConfiguration<T>[]+ rowKey: string+ tappedKey: string | null+ onTap: (key: string | null) => void+}) {+ const [isHovered, setIsHovered] = useState(false)+ const isTapped = tappedKey === rowKey+ const isActive = isHovered || isTapped- const rowName = (item as unknown as { name: string }).name- const isTapped = tappedRowName === rowName- const isRowActive = isHovered || isTapped-- const handleRowClick = (e: React.MouseEvent) => {+ const handleClick = (e: React.MouseEvent) => {if (window.innerWidth < 768 && !(e.target as HTMLElement).closest('a')) {- if (onRowTap) {- if (isTapped) {- onRowTap(null)- } else {- onRowTap(rowName)- }- }+ onTap(isTapped ? null : rowKey)}}@@ -110,106 +31,67 @@ export const ItemRow = <T extends Record<string, string | number | ReactNode>>({className="group text-sm dark:text-gray-200 md:cursor-default cursor-pointer"onMouseEnter={() => setIsHovered(true)}onMouseLeave={() => setIsHovered(false)}- onClick={handleRowClick}+ onClick={handleClick}>- {columns.map(({ key, width, align, renderValue, renderItem }) => (- <TableCell- key={`${(pageIndex ?? null) === null ? '' : `page_${pageIndex}_`}row_${rowIndex}_${String(key)}`}- className={width}- align={align}+ {columns.map((col) => (+ <td+ key={`${col.key}_${rowKey}`}+ className={classNames(+ 'p-2 font-medium first:rounded-s-sm last:rounded-e-sm',+ col.width+ )}+ align={col.align}>- {renderItem- ? renderItem(item)- : renderValue- ? renderValue(item, isRowActive)- : (item[key] ?? '')}- </TableCell>+ {col.renderCell(row, isActive)}+ </td>))}</tr>)}-export const Table = <T extends Record<string, string | number | ReactNode>>({+export function Table<T>({data,- columns+ columns,+ getRowKey}: {- columns: ColumnConfiguraton<T>[]- data: T[] | { pages: T[][] }-}) => {- const [tappedRowName, setTappedRowName] = React.useState<string | null>(null)-- const renderColumnLabel = (column: ColumnConfiguraton<T>) => {- if (column.metricWarning) {- return (- <Tooltip- info={warningSpan(column.metricWarning)}- className="inline-block"- >- {column.label + ' *'}- </Tooltip>- )- } else {- return column.label- }- }-- const warningSpan = (warning: string) => {- return (- <span className="text-xs font-normal whitespace-nowrap">- {'* ' + warning}- </span>- )- }+ data: { pages: T[][] }+ columns: ColumnConfiguration<T>[]+ getRowKey: (row: T) => string+}) {+ const [tappedKey, setTappedKey] = useState<string | null>(null)return (<table className="border-collapse table-striped table-fixed w-max min-w-full"><thead className="sticky top-0 bg-white dark:bg-gray-900 z-10"><tr className="text-xs font-semibold text-gray-500 dark:text-gray-400">- {columns.map((column) => (- <TableHeaderCell- key={`header_${String(column.key)}`}- className={classNames('p-2', column.width)}- align={column.align}+ {columns.map((col) => (+ <th+ key={`header_${col.key}`}+ data-testid="report-header"+ className={classNames('p-2', col.width)}+ align={col.align}>- {column.onSort ? (- <SortButton- toggleSort={column.onSort}- sortDirection={column.sortDirection ?? null}- >- {renderColumnLabel(column)}- </SortButton>- ) : (- renderColumnLabel(column)- )}- </TableHeaderCell>+ {col.renderLabel()}+ </th>))}</tr></thead><tbody>- {Array.isArray(data)- ? data.map((item, rowIndex) => (- <ItemRow- item={item}+ {data.pages.map((page, pageIndex) =>+ page.map((row) => {+ const rowKey = `${getRowKey(row)}_${pageIndex}`+ return (+ <Row+ key={rowKey}+ row={row}columns={columns}- rowIndex={rowIndex}- key={rowIndex}- tappedRowName={tappedRowName}- onRowTap={setTappedRowName}+ rowKey={rowKey}+ tappedKey={tappedKey}+ onTap={setTappedKey}/>- ))- : data.pages.map((page, pageIndex) =>- page.map((item, rowIndex) => (- <ItemRow- item={item}- columns={columns}- rowIndex={rowIndex}- pageIndex={pageIndex}- key={`page_${pageIndex}_row_${rowIndex}`}- tappedRowName={tappedRowName}- onRowTap={setTappedRowName}- />- ))- )}+ )+ })+ )}</tbody></table>)diff --git a/assets/js/dashboard/hooks/api-client.ts b/assets/js/dashboard/hooks/api-client.tsindex 5b944c5117..25660ad587 100644--- a/assets/js/dashboard/hooks/api-client.ts+++ b/assets/js/dashboard/hooks/api-client.ts@@ -13,6 +13,8 @@ import {} from '../dashboard-time-periods'import { REALTIME_UPDATE_TIME_MS } from '../util/realtime-update-timer'import { Interval, validIntervals } from '../stats/graph/intervals'+import { PlausibleSite } from '../site-context'+import { StatsQuery } from '../stats-query'// define (in ms) when query API responses should become staleexport const CACHE_TTL_REALTIME = REALTIME_UPDATE_TIME_MS@@ -32,6 +34,54 @@ type GetRequestParams<TKey extends PaginatedQueryKeyBase> = (k: TKey) => [DashboardState, Record<string, unknown>]+/**+ * Hook for paginated POST /api/stats/:domain/query requests (i.e. Details views).+ */+export function usePaginatedQueryAPI({+ site,+ dashboardState,+ statsQuery+}: {+ site: PlausibleSite+ dashboardState: DashboardState+ statsQuery: StatsQuery+}) {+ const queryClient = useQueryClient()+ const dimensionKey = statsQuery.dimensions.join(',')++ useEffect(() => {+ return () => {+ const tanstackQueryFilters: QueryFilters = {+ predicate: ({ queryKey }) => queryKey[0] === dimensionKey+ }+ queryClient.setQueriesData(tanstackQueryFilters, cleanToPageOne)+ }+ }, [queryClient, dimensionKey])++ return useInfiniteQuery({+ queryKey: [dimensionKey, statsQuery],+ queryFn: async ({ pageParam }): Promise<api.QueryApiResponse> => {+ return api.stats(site, {+ ...statsQuery,+ pagination: { limit: PAGINATION_LIMIT, offset: pageParam as number }+ })+ },+ getNextPageParam: (lastPage, _, lastPageParam) => {+ return lastPage.results.length === PAGINATION_LIMIT+ ? (lastPageParam as number) + PAGINATION_LIMIT+ : null+ },+ staleTime: () =>+ getStaleTime({+ siteTimezoneOffset: site.offset,+ siteStatsBegin: site.statsBegin,+ ...dashboardState+ }),+ initialPageParam: 0,+ placeholderData: (previousData) => previousData+ })+}+/*** Hook that fetches the first page from the defined GET endpoint on mount,* then subsequent pages when component calls fetchNextPage.diff --git a/assets/js/dashboard/hooks/use-order-by-legacy.test.ts b/assets/js/dashboard/hooks/use-order-by-legacy.test.tsnew file mode 100644index 0000000000..8e5a1a8cbf--- /dev/null+++ b/assets/js/dashboard/hooks/use-order-by-legacy.test.ts@@ -0,0 +1,163 @@+import { Metric } from '../stats/reports/metrics'+import {+ OrderBy,+ SortDirection,+ cycleSortDirection,+ findOrderIndex,+ getOrderByStorageKey,+ getStoredOrderBy,+ maybeStoreOrderBy,+ rearrangeOrderBy,+ validateOrderBy+} from './use-order-by-legacy'++describe(`${findOrderIndex.name}`, () => {+ /* prettier-ignore */+ const cases: [OrderBy, Pick<Metric, 'key'>, number][] = [+ [[], { key: 'anything' }, -1],+ [[['visitors', SortDirection.asc]], { key: 'anything' }, -1],+ [[['bounce_rate', SortDirection.desc], ['visitors', SortDirection.asc]], {key: 'bounce_rate'}, 0],+ [[['bounce_rate', SortDirection.desc], ['visitors', SortDirection.asc]], {key: 'visitors'}, 1]+ ]++ test.each(cases)(+ `[%#] in order by %p, the index of metric %p is %p`,+ (orderBy, metric, expectedIndex) => {+ expect(findOrderIndex(orderBy, metric)).toEqual(expectedIndex)+ }+ )+})++describe(`${cycleSortDirection.name}`, () => {+ test.each([+ [+ null,+ {+ direction: SortDirection.desc,+ hint: 'Press to sort column in descending order'+ }+ ],+ [+ SortDirection.desc,+ {+ direction: SortDirection.asc,+ hint: 'Press to sort column in ascending order'+ }+ ],+ [+ SortDirection.asc,+ {+ direction: SortDirection.desc,+ hint: 'Press to sort column in descending order'+ }+ ]+ ])(+ 'for current direction %p returns %p',+ (currentDirection, expectedOutput) => {+ expect(cycleSortDirection(currentDirection)).toEqual(expectedOutput)+ }+ )+})++describe(`${rearrangeOrderBy.name}`, () => {+ const cases: [Pick<Metric, 'key'>, OrderBy, OrderBy][] = [+ [+ { key: 'visitors' },+ [['visitors', SortDirection.asc]],+ [['visitors', SortDirection.desc]]+ ],+ [+ { key: 'visitors' },+ [['visitors', SortDirection.desc]],+ [['visitors', SortDirection.asc]]+ ],+ [+ { key: 'visit_duration' },+ [['visitors', SortDirection.asc]],+ [['visit_duration', SortDirection.desc]]+ ]+ ]+ it.each(cases)(+ `[%#] clicking on %p yields expected order`,+ (metric, currentOrderBy, expectedOrderBy) => {+ expect(rearrangeOrderBy(currentOrderBy, metric)).toEqual(expectedOrderBy)+ }+ )+})++describe(`${validateOrderBy.name}`, () => {+ test.each([+ [false, '', []],+ [false, [], []],+ [false, [['a']], [{ key: 'a' }]],+ [false, [['a', 'b']], [{ key: 'a' }]],+ [+ false,+ [+ ['a', 'desc'],+ ['a', 'asc']+ ],+ [{ key: 'a' }]+ ],+ [true, [['a', 'desc']], [{ key: 'a' }]]+ ])(+ '[%#] returns %p given input %p and sortable metrics %p',+ (expected, input, sortableMetrics) => {+ expect(validateOrderBy(input, sortableMetrics)).toBe(expected)+ }+ )+})++describe(`storing detailed report preferred order`, () => {+ const domain = 'any-domain'+ const reportInfo = { dimensionLabel: 'Goal' }++ it('does not store invalid value', () => {+ maybeStoreOrderBy({+ orderBy: [['foo', SortDirection.desc]],+ domain,+ reportInfo,+ metrics: [{ key: 'foo', sortable: false }]+ })+ expect(localStorage.getItem(getOrderByStorageKey(domain, reportInfo))).toBe(+ null+ )+ })++ it('falls back to fallbackValue if metric has become unsortable between storing and retrieving', () => {+ maybeStoreOrderBy({+ orderBy: [['c', SortDirection.desc]],+ domain,+ reportInfo,+ metrics: [{ key: 'c', sortable: true }]+ })+ const inStorage = localStorage.getItem(+ getOrderByStorageKey(domain, reportInfo)+ )+ expect(inStorage).toBe('[["c","desc"]]')+ expect(+ getStoredOrderBy({+ domain,+ reportInfo,+ metrics: [{ key: 'c', sortable: false }],+ fallbackValue: [['visitors', SortDirection.desc]]+ })+ ).toEqual([['visitors', SortDirection.desc]])+ })++ it('retrieves stored value correctly', () => {+ const input = [['any-column', SortDirection.asc]]+ localStorage.setItem(+ getOrderByStorageKey(domain, reportInfo),+ JSON.stringify(input)+ )+ expect(+ getStoredOrderBy({+ domain,+ reportInfo,+ metrics: [{ key: 'any-column', sortable: true }],+ fallbackValue: [['visitors', SortDirection.desc]]+ })+ ).toEqual(input)+ })+})diff --git a/assets/js/dashboard/hooks/use-order-by-legacy.ts b/assets/js/dashboard/hooks/use-order-by-legacy.tsnew file mode 100644index 0000000000..a8908f4fca--- /dev/null+++ b/assets/js/dashboard/hooks/use-order-by-legacy.ts@@ -0,0 +1,200 @@+import { useCallback, useEffect, useMemo, useState } from 'react'+import { Metric } from '../stats/reports/metrics'+import { getDomainScopedStorageKey, getItem, setItem } from '../util/storage'+import { useSiteContext } from '../site-context'+import { ReportInfo } from '../stats/modals/breakdown-modal-legacy'++export enum SortDirection {+ asc = 'asc',+ desc = 'desc'+}++export type Order = [Metric['key'], SortDirection]++export type OrderBy = Order[]++export const getSortDirectionLabel = (sortDirection: SortDirection): string =>+ ({+ [SortDirection.asc]: 'Sorted in ascending order',+ [SortDirection.desc]: 'Sorted in descending order'+ })[sortDirection]++export function useOrderBy({+ metrics,+ defaultOrderBy+}: {+ metrics: Pick<Metric, 'key'>[]+ defaultOrderBy: OrderBy+}) {+ const [orderBy, setOrderBy] = useState<OrderBy>([])+ const orderByDictionary: Record<Metric['key'], SortDirection> = useMemo(+ () =>+ orderBy.length+ ? Object.fromEntries(orderBy)+ : Object.fromEntries(defaultOrderBy),+ [orderBy, defaultOrderBy]+ )++ const toggleSortByMetric = useCallback(+ (metric: Pick<Metric, 'key'>) => {+ if (!metrics.find(({ key }) => key === metric.key)) {+ return+ }+ setOrderBy((currentOrderBy) =>+ rearrangeOrderBy(+ currentOrderBy.length ? currentOrderBy : defaultOrderBy,+ metric+ )+ )+ },+ [metrics, defaultOrderBy]+ )++ return {+ orderBy: orderBy.length ? orderBy : defaultOrderBy,+ orderByDictionary,+ toggleSortByMetric+ }+}++export function cycleSortDirection(+ currentSortDirection: SortDirection | null+): { direction: SortDirection; hint: string } {+ if (currentSortDirection === SortDirection.desc) {+ return {+ direction: SortDirection.asc,+ hint: 'Press to sort column in ascending order'+ }+ }++ return {+ direction: SortDirection.desc,+ hint: 'Press to sort column in descending order'+ }+}++export function findOrderIndex(orderBy: OrderBy, metric: Pick<Metric, 'key'>) {+ return orderBy.findIndex(([metricKey]) => metricKey === metric.key)+}++export function rearrangeOrderBy(+ currentOrderBy: OrderBy,+ metric: Pick<Metric, 'key'>+): OrderBy {+ const orderIndex = findOrderIndex(currentOrderBy, metric)+ if (orderIndex < 0) {+ const sortDirection = cycleSortDirection(null).direction as SortDirection+ return [[metric.key, sortDirection]]+ }+ const previousOrder = currentOrderBy[orderIndex]+ const sortDirection = cycleSortDirection(previousOrder[1]).direction+ if (sortDirection === null) {+ return []+ }+ return [[metric.key, sortDirection]]+}++export function getOrderByStorageKey(+ domain: string,+ reportInfo: Pick<ReportInfo, 'dimensionLabel'>+) {+ const storageKey = getDomainScopedStorageKey(+ `order_${reportInfo.dimensionLabel}_by`,+ domain+ )+ return storageKey+}++export function validateOrderBy(+ orderBy: unknown,+ metrics: Pick<Metric, 'key'>[]+): orderBy is OrderBy {+ if (!Array.isArray(orderBy)) {+ return false+ }+ if (orderBy.length !== 1) {+ return false+ }+ if (!Array.isArray(orderBy[0])) {+ return false+ }+ if (+ orderBy[0].length === 2 &&+ metrics.findIndex((m) => m.key === orderBy[0][0]) > -1 &&+ [SortDirection.asc, SortDirection.desc].includes(orderBy[0][1])+ ) {+ return true+ }+ return false+}++export function getStoredOrderBy({+ domain,+ reportInfo,+ metrics,+ fallbackValue+}: {+ domain: string+ reportInfo: Pick<ReportInfo, 'dimensionLabel'>+ metrics: Pick<Metric, 'key' | 'sortable'>[]+ fallbackValue: OrderBy+}): OrderBy {+ try {+ const storedItem = getItem(getOrderByStorageKey(domain, reportInfo))+ const parsed = JSON.parse(storedItem)+ if (+ validateOrderBy(+ parsed,+ metrics.filter((m) => m.sortable)+ )+ ) {+ return parsed+ } else {+ throw new Error('Invalid stored order_by value')+ }+ } catch (_e) {+ return fallbackValue+ }+}++export function maybeStoreOrderBy({+ domain,+ reportInfo,+ metrics,+ orderBy+}: {+ domain: string+ reportInfo: Pick<ReportInfo, 'dimensionLabel'>+ metrics: Pick<Metric, 'key' | 'sortable'>[]+ orderBy: OrderBy+}) {+ if (+ validateOrderBy(+ orderBy,+ metrics.filter((m) => m.sortable)+ )+ ) {+ setItem(getOrderByStorageKey(domain, reportInfo), JSON.stringify(orderBy))+ }+}++export function useRememberOrderBy({+ effectiveOrderBy,+ metrics,+ reportInfo+}: {+ effectiveOrderBy: OrderBy+ metrics: Pick<Metric, 'key' | 'sortable'>[]+ reportInfo: Pick<ReportInfo, 'dimensionLabel'>+}) {+ const site = useSiteContext()++ useEffect(() => {+ maybeStoreOrderBy({+ domain: site.domain,+ metrics,+ reportInfo,+ orderBy: effectiveOrderBy+ })+ }, [site, reportInfo, effectiveOrderBy, metrics])+}diff --git a/assets/js/dashboard/hooks/use-order-by.test.ts b/assets/js/dashboard/hooks/use-order-by.test.tsindex 40e63fcf42..0440037567 100644--- a/assets/js/dashboard/hooks/use-order-by.test.ts+++ b/assets/js/dashboard/hooks/use-order-by.test.ts@@ -1,9 +1,8 @@-import { Metric } from '../stats/reports/metrics'+import { Metric } from '../stats/metrics'import {OrderBy,SortDirection,cycleSortDirection,- findOrderIndex,getOrderByStorageKey,getStoredOrderBy,maybeStoreOrderBy,@@ -11,23 +10,6 @@ import {validateOrderBy} from './use-order-by'-describe(`${findOrderIndex.name}`, () => {- /* prettier-ignore */- const cases: [OrderBy, Pick<Metric, 'key'>, number][] = [- [[], { key: 'anything' }, -1],- [[['visitors', SortDirection.asc]], { key: 'anything' }, -1],- [[['bounce_rate', SortDirection.desc], ['visitors', SortDirection.asc]], {key: 'bounce_rate'}, 0],- [[['bounce_rate', SortDirection.desc], ['visitors', SortDirection.asc]], {key: 'visitors'}, 1]- ]-- test.each(cases)(- `[%#] in order by %p, the index of metric %p is %p`,- (orderBy, metric, expectedIndex) => {- expect(findOrderIndex(orderBy, metric)).toEqual(expectedIndex)- }- )-})-describe(`${cycleSortDirection.name}`, () => {test.each([[@@ -60,19 +42,19 @@ describe(`${cycleSortDirection.name}`, () => {})describe(`${rearrangeOrderBy.name}`, () => {- const cases: [Pick<Metric, 'key'>, OrderBy, OrderBy][] = [+ const cases: [Metric, OrderBy, OrderBy][] = [[- { key: 'visitors' },+ 'visitors',[['visitors', SortDirection.asc]],[['visitors', SortDirection.desc]]],[- { key: 'visitors' },+ 'visitors',[['visitors', SortDirection.desc]],[['visitors', SortDirection.asc]]],[- { key: 'visit_duration' },+ 'visit_duration',[['visitors', SortDirection.asc]],[['visit_duration', SortDirection.desc]]]@@ -89,73 +71,73 @@ describe(`${validateOrderBy.name}`, () => {test.each([[false, '', []],[false, [], []],- [false, [['a']], [{ key: 'a' }]],- [false, [['a', 'b']], [{ key: 'a' }]],+ [false, [['visitors']], ['visitors']],+ [false, [['visitors', 'b']], ['visitors']],[false,[- ['a', 'desc'],- ['a', 'asc']+ ['visitors', 'desc'],+ ['visitors', 'asc']],- [{ key: 'a' }]+ ['visitors']],- [true, [['a', 'desc']], [{ key: 'a' }]]+ [true, [['visitors', 'desc']], ['visitors']]])('[%#] returns %p given input %p and sortable metrics %p',(expected, input, sortableMetrics) => {- expect(validateOrderBy(input, sortableMetrics)).toBe(expected)+ expect(validateOrderBy(input, sortableMetrics as Metric[])).toBe(expected)})})describe(`storing detailed report preferred order`, () => {const domain = 'any-domain'- const reportInfo = { dimensionLabel: 'Goal' }+ const dimensionLabel = 'Goal'it('does not store invalid value', () => {maybeStoreOrderBy({- orderBy: [['foo', SortDirection.desc]],+ orderBy: [['total_visitors', SortDirection.desc]],domain,- reportInfo,- metrics: [{ key: 'foo', sortable: false }]+ dimensionLabel,+ metrics: ['total_visitors']})- expect(localStorage.getItem(getOrderByStorageKey(domain, reportInfo))).toBe(- null- )+ expect(+ localStorage.getItem(getOrderByStorageKey(domain, dimensionLabel))+ ).toBe(null)})it('falls back to fallbackValue if metric has become unsortable between storing and retrieving', () => {maybeStoreOrderBy({- orderBy: [['c', SortDirection.desc]],+ orderBy: [['visitors', SortDirection.desc]],domain,- reportInfo,- metrics: [{ key: 'c', sortable: true }]+ dimensionLabel,+ metrics: ['visitors']})const inStorage = localStorage.getItem(- getOrderByStorageKey(domain, reportInfo)+ getOrderByStorageKey(domain, dimensionLabel))- expect(inStorage).toBe('[["c","desc"]]')+ expect(inStorage).toBe('[["visitors","desc"]]')expect(getStoredOrderBy({domain,- reportInfo,- metrics: [{ key: 'c', sortable: false }],+ dimensionLabel,+ metrics: ['total_visitors'],fallbackValue: [['visitors', SortDirection.desc]]})).toEqual([['visitors', SortDirection.desc]])})it('retrieves stored value correctly', () => {- const input = [['any-column', SortDirection.asc]]+ const input: OrderBy = [['visitors', SortDirection.asc]]localStorage.setItem(- getOrderByStorageKey(domain, reportInfo),+ getOrderByStorageKey(domain, dimensionLabel),JSON.stringify(input))expect(getStoredOrderBy({domain,- reportInfo,- metrics: [{ key: 'any-column', sortable: true }],+ dimensionLabel,+ metrics: ['visitors'],fallbackValue: [['visitors', SortDirection.desc]]})).toEqual(input)diff --git a/assets/js/dashboard/hooks/use-order-by.ts b/assets/js/dashboard/hooks/use-order-by.tsindex 28bde044af..01b5de2a23 100644--- a/assets/js/dashboard/hooks/use-order-by.ts+++ b/assets/js/dashboard/hooks/use-order-by.ts@@ -1,15 +1,14 @@import { useCallback, useEffect, useMemo, useState } from 'react'-import { Metric } from '../stats/reports/metrics'+import { isSortable, Metric } from '../stats/metrics'import { getDomainScopedStorageKey, getItem, setItem } from '../util/storage'import { useSiteContext } from '../site-context'-import { ReportInfo } from '../stats/modals/breakdown-modal'export enum SortDirection {asc = 'asc',desc = 'desc'}-export type Order = [Metric['key'], SortDirection]+export type Order = [string, SortDirection]export type OrderBy = Order[]@@ -23,11 +22,11 @@ export function useOrderBy({metrics,defaultOrderBy}: {- metrics: Pick<Metric, 'key'>[]+ metrics: Metric[]defaultOrderBy: OrderBy}) {const [orderBy, setOrderBy] = useState<OrderBy>([])- const orderByDictionary: Record<Metric['key'], SortDirection> = useMemo(+ const orderByDictionary = useMemo(() =>orderBy.length? Object.fromEntries(orderBy)@@ -36,8 +35,8 @@ export function useOrderBy({)const toggleSortByMetric = useCallback(- (metric: Pick<Metric, 'key'>) => {- if (!metrics.find(({ key }) => key === metric.key)) {+ (metric: Metric) => {+ if (!metrics.find((m) => m === metric)) {return}setOrderBy((currentOrderBy) =>@@ -73,33 +72,26 @@ export function cycleSortDirection(}}-export function findOrderIndex(orderBy: OrderBy, metric: Pick<Metric, 'key'>) {- return orderBy.findIndex(([metricKey]) => metricKey === metric.key)-}-export function rearrangeOrderBy(currentOrderBy: OrderBy,- metric: Pick<Metric, 'key'>+ metric: Metric): OrderBy {- const orderIndex = findOrderIndex(currentOrderBy, metric)+ const orderIndex = currentOrderBy.findIndex(([m]) => m === metric)if (orderIndex < 0) {const sortDirection = cycleSortDirection(null).direction as SortDirection- return [[metric.key, sortDirection]]+ return [[metric, sortDirection]]}const previousOrder = currentOrderBy[orderIndex]const sortDirection = cycleSortDirection(previousOrder[1]).directionif (sortDirection === null) {return []}- return [[metric.key, sortDirection]]+ return [[metric, sortDirection]]}-export function getOrderByStorageKey(- domain: string,- reportInfo: Pick<ReportInfo, 'dimensionLabel'>-) {+export function getOrderByStorageKey(domain: string, dimensionLabel: string) {const storageKey = getDomainScopedStorageKey(- `order_${reportInfo.dimensionLabel}_by`,+ `order_${dimensionLabel}_by`,domain)return storageKey@@ -107,7 +99,7 @@ export function getOrderByStorageKey(export function validateOrderBy(orderBy: unknown,- metrics: Pick<Metric, 'key'>[]+ metrics: Metric[]): orderBy is OrderBy {if (!Array.isArray(orderBy)) {return false@@ -120,7 +112,7 @@ export function validateOrderBy(}if (orderBy[0].length === 2 &&- metrics.findIndex((m) => m.key === orderBy[0][0]) > -1 &&+ metrics.findIndex((m) => m === orderBy[0][0]) > -1 &&[SortDirection.asc, SortDirection.desc].includes(orderBy[0][1])) {return true@@ -130,24 +122,19 @@ export function validateOrderBy(export function getStoredOrderBy({domain,- reportInfo,+ dimensionLabel,metrics,fallbackValue}: {domain: string- reportInfo: Pick<ReportInfo, 'dimensionLabel'>- metrics: Pick<Metric, 'key' | 'sortable'>[]+ dimensionLabel: string+ metrics: Metric[]fallbackValue: OrderBy}): OrderBy {try {- const storedItem = getItem(getOrderByStorageKey(domain, reportInfo))+ const storedItem = getItem(getOrderByStorageKey(domain, dimensionLabel))const parsed = JSON.parse(storedItem)- if (- validateOrderBy(- parsed,- metrics.filter((m) => m.sortable)- )- ) {+ if (validateOrderBy(parsed, metrics.filter(isSortable))) {return parsed} else {throw new Error('Invalid stored order_by value')@@ -159,33 +146,36 @@ export function getStoredOrderBy({export function maybeStoreOrderBy({domain,- reportInfo,+ dimensionLabel,metrics,orderBy}: {domain: string- reportInfo: Pick<ReportInfo, 'dimensionLabel'>- metrics: Pick<Metric, 'key' | 'sortable'>[]+ dimensionLabel: string+ metrics: Metric[]orderBy: OrderBy}) {if (validateOrderBy(orderBy,- metrics.filter((m) => m.sortable)+ metrics.filter((m) => isSortable(m)))) {- setItem(getOrderByStorageKey(domain, reportInfo), JSON.stringify(orderBy))+ setItem(+ getOrderByStorageKey(domain, dimensionLabel),+ JSON.stringify(orderBy)+ )}}export function useRememberOrderBy({effectiveOrderBy,metrics,- reportInfo+ dimensionLabel}: {effectiveOrderBy: OrderBy- metrics: Pick<Metric, 'key' | 'sortable'>[]- reportInfo: Pick<ReportInfo, 'dimensionLabel'>+ metrics: Metric[]+ dimensionLabel: string}) {const site = useSiteContext()@@ -193,8 +183,8 @@ export function useRememberOrderBy({maybeStoreOrderBy({domain: site.domain,metrics,- reportInfo,+ dimensionLabel,orderBy: effectiveOrderBy})- }, [site, reportInfo, effectiveOrderBy, metrics])+ }, [site, dimensionLabel, effectiveOrderBy, metrics])}diff --git a/assets/js/dashboard/router.tsx b/assets/js/dashboard/router.tsxindex df0d707851..355bee142f 100644--- a/assets/js/dashboard/router.tsx+++ b/assets/js/dashboard/router.tsx@@ -11,9 +11,9 @@ import Dashboard from './index'import SourcesModal from './stats/modals/sources'import ReferrersDrilldownModal from './stats/modals/referrer-drilldown'import GoogleKeywordsModal from './stats/modals/google-keywords'-import PagesModal from './stats/modals/pages'-import EntryPagesModal from './stats/modals/entry-pages'-import ExitPagesModal from './stats/modals/exit-pages'+import { PagesDetails } from './stats/pages/pages'+import { EntryPagesDetails } from './stats/pages/entry-pages'+import { ExitPagesDetails } from './stats/pages/exit-pages'import LocationsModal from './stats/modals/locations-modal'import BrowsersModal from './stats/modals/devices/browsers-modal'import BrowserVersionsModal from './stats/modals/devices/browser-versions-modal'@@ -101,17 +101,17 @@ export const referrersGoogleRoute = {export const topPagesRoute = {path: 'pages',- element: <PagesModal />+ element: <PagesDetails />}export const entryPagesRoute = {path: 'entry-pages',- element: <EntryPagesModal />+ element: <EntryPagesDetails />}export const exitPagesRoute = {path: 'exit-pages',- element: <ExitPagesModal />+ element: <ExitPagesDetails />}export const countriesRoute = {diff --git a/assets/js/dashboard/stats-query.ts b/assets/js/dashboard/stats-query.tsindex 0f356fdf56..46107fd013 100644--- a/assets/js/dashboard/stats-query.ts+++ b/assets/js/dashboard/stats-query.ts@@ -1,9 +1,23 @@-import { Metric } from '../types/query-api'-import { DashboardState, Filter } from './dashboard-state'+import { Metric } from './stats/metrics'+import {+ DashboardState,+ FilterOperator,+ FilterKey,+ FilterClause+} from './dashboard-state'+import { OrderBy } from './hooks/use-order-by'import { ComparisonMode, DashboardPeriod } from './dashboard-time-periods'import { formatISO } from './util/date'import { remapToApiFilters } from './util/filters'+export type FilterModifiers = { case_sensitive?: boolean }++export type ApiFilter =+ | [FilterOperator, FilterKey, FilterClause[]]+ | [FilterOperator, FilterKey, FilterClause[], FilterModifiers]++type Pagination = { limit: number; offset: number }+type DateRange = DashboardPeriod | [string, string]type IncludeCompare =| ComparisonMode.previous_period@@ -26,15 +40,26 @@ export type ReportParams = {metrics: Metric[]dimensions?: string[]include?: Partial<QueryInclude>+ order_by?: OrderBy+ pagination?: Pagination}export type StatsQuery = {date_range: DateRangerelative_date: string | null- filters: Filter[]+ filters: ApiFilter[]dimensions: string[]metrics: Metric[]include: QueryInclude+ order_by?: OrderBy | null+ pagination?: Pagination | null+}++export function addFilter(+ statsQuery: StatsQuery,+ filter: ApiFilter+): StatsQuery {+ return { ...statsQuery, filters: [...statsQuery.filters, filter] }}export function createStatsQuery(@@ -47,6 +72,8 @@ export function createStatsQuery(dimensions: reportParams.dimensions || [],metrics: reportParams.metrics,filters: remapToApiFilters(dashboardState.filters),+ order_by: reportParams.order_by || null,+ pagination: reportParams.pagination || null,include: {imports: dashboardState.with_imported,imports_meta: reportParams.include?.imports_meta || false,diff --git a/assets/js/dashboard/stats/behaviours/conversions.js b/assets/js/dashboard/stats/behaviours/conversions.jsindex aa5ff34dc1..a99841f99c 100644--- a/assets/js/dashboard/stats/behaviours/conversions.js+++ b/assets/js/dashboard/stats/behaviours/conversions.js@@ -3,7 +3,7 @@ import * as api from '../../api'import * as url from '../../util/url'import * as metrics from '../reports/metrics'-import ListReport from '../reports/list'+import ListReport from '../reports/list-legacy'import { useSiteContext } from '../../site-context'import { useDashboardStateContext } from '../../dashboard-state-context'diff --git a/assets/js/dashboard/stats/behaviours/props.js b/assets/js/dashboard/stats/behaviours/props.jsindex 8f7f8b7930..769e5d0301 100644--- a/assets/js/dashboard/stats/behaviours/props.js+++ b/assets/js/dashboard/stats/behaviours/props.js@@ -1,5 +1,5 @@import React from 'react'-import ListReport, { MIN_HEIGHT } from '../reports/list'+import ListReport, { MIN_HEIGHT } from '../reports/list-legacy'import * as metrics from '../reports/metrics'import * as api from '../../api'import * as url from '../../util/url'diff --git a/assets/js/dashboard/stats/behaviours/special-goal-prop-breakdown.js b/assets/js/dashboard/stats/behaviours/special-goal-prop-breakdown.jsindex 700b920425..b82ef8368f 100644--- a/assets/js/dashboard/stats/behaviours/special-goal-prop-breakdown.js+++ b/assets/js/dashboard/stats/behaviours/special-goal-prop-breakdown.js@@ -1,5 +1,5 @@import React from 'react'-import ListReport from '../reports/list'+import ListReport from '../reports/list-legacy'import * as metrics from '../reports/metrics'import * as url from '../../util/url'import * as api from '../../api'diff --git a/assets/js/dashboard/stats/breakdowns.tsx b/assets/js/dashboard/stats/breakdowns.tsxnew file mode 100644index 0000000000..166f21aa6f--- /dev/null+++ b/assets/js/dashboard/stats/breakdowns.tsx@@ -0,0 +1,206 @@+import React, { ReactNode, useEffect, useRef } from 'react'+import { SortDirection } from '../hooks/use-order-by'+import type { QueryResultRow, QueryResultQuery } from '../api'+import { Metric } from './metrics'+import { FilterInfo } from '../components/drilldown-link'+import { ChangeArrow } from './reports/change-arrow'+import { MetricFormatterLong, ValueType } from './reports/metric-formatter'+import dayjs from 'dayjs'+import { addFilter, ApiFilter, StatsQuery } from '../stats-query'++export type SharedBreakdownReportProps = {+ dimensionLabel: string+ dimensions: string[]+ metrics: Metric[]+ getFilterInfo: (row: QueryResultRow) => FilterInfo | null+ getExternalLinkUrl?: (row: QueryResultRow) => string | null+}++export type ColumnConfiguration<T> = {+ /** Unique column ID, used for sorting purposes and as a React key */+ key: string+ /** Column title */+ renderLabel: () => ReactNode+ /** Renders any cell in this column — name cells, metric cells, etc. */+ renderCell: (item: T, isActive?: boolean) => ReactNode+ /** If defined, the column is considered sortable. @see SortButton */+ onSort?: () => void+ sortDirection?: SortDirection+ /** CSS class string. @example "w-24 md:w-32" */+ width?: string+ /** Aligns column content. */+ align?: 'left' | 'right'+}++export function MetricValueTooltipContent({+ value,+ comparison,+ metric,+ metricLabel,+ dateRangeLabel,+ comparisonDateRangeLabel+}: {+ value: ValueType+ comparison: { value: ValueType; change: number } | null+ metric: Metric+ metricLabel: string+ dateRangeLabel: string+ comparisonDateRangeLabel: string | null+}) {+ const longFormatter = MetricFormatterLong[metric]+ const label = metricLabel.length >= 3 ? ` ${metricLabel.toLowerCase()}` : ''++ if (comparison && comparisonDateRangeLabel) {+ return (+ <div className="text-left whitespace-nowrap py-1 space-y-2">+ <div>+ <div className="flex gap-x-4">+ <div className="flex flex-col">+ <span className="font-medium text-sm/6 text-white">+ {longFormatter(value)}+ {label}+ </span>+ <div className="font-normal text-xs text-white">+ {dateRangeLabel}+ </div>+ </div>+ <ChangeArrow+ metric={metric}+ change={comparison.change}+ className="text-xs/6 font-medium text-white"+ />+ </div>+ </div>+ <div className="w-full border-t border-gray-600" />+ <div>+ <div className="font-medium text-sm/6 text-gray-300/80">+ {longFormatter(comparison.value)}+ {label}+ </div>+ <div className="font-normal text-xs text-gray-300/80">+ {comparisonDateRangeLabel}+ </div>+ </div>+ </div>+ )+ }++ return <div className="whitespace-nowrap">{longFormatter(value)}</div>+}++export function formatDateRangeLabel([from, to]: [string, string]): string {+ const fromDay = dayjs(from.slice(0, 19))+ const toDay = dayjs(to.slice(0, 19))+ if (fromDay.isSame(toDay, 'day')) return fromDay.format('D MMM YYYY')+ if (fromDay.isSame(toDay, 'year'))+ return `${fromDay.format('D MMM')} - ${toDay.format('D MMM YYYY')}`+ return `${fromDay.format('D MMM YY')} - ${toDay.format('D MMM YY')}`+}++export function useBodyPortalRef() {+ const portalRef = useRef<HTMLElement | null>(null)+ useEffect(() => {+ if (typeof document !== 'undefined') {+ portalRef.current = document.body+ }+ }, [])+ return portalRef+}++export function ExternalLinkIcon() {+ return (+ <svg+ xmlns="http://www.w3.org/2000/svg"+ fill="none"+ viewBox="0 0 24 24"+ className="inline size-3.5 mb-0.5 text-gray-600 dark:text-gray-400 hover:text-gray-800 dark:hover:text-gray-200"+ >+ <path+ stroke="currentColor"+ strokeLinecap="round"+ strokeLinejoin="round"+ strokeWidth="2"+ d="M9 5H5a2 2 0 0 0-2 2v12a2 2 0 0 0 2 2h12a2 2 0 0 0 2-2v-4M12 12l9-9-.303.303M14 3h7v7"+ />+ </svg>+ )+}++export function extractMetricValue(+ row: QueryResultRow,+ query: QueryResultQuery,+ metricKey: string+): {+ metricIndex: number+ value: ValueType+ comparison: { value: ValueType; change: number } | null+} {+ const metricIndex = query.metrics.indexOf(metricKey as Metric)+ const value: ValueType =+ metricIndex >= 0 ? (row.metrics[metricIndex] ?? null) : null+ const comparison =+ row.comparison && query.comparison_date_range+ ? {+ value: row.comparison.metrics[metricIndex] ?? null,+ change: row.comparison.change[metricIndex]+ }+ : null+ return { metricIndex, value, comparison }+}++const DEFAULT_DETAILED_METRICS = [+ 'visitors',+ 'percentage',+ 'bounce_rate',+ 'visit_duration'+] as Metric[]++export const getBreakdownMetrics = ({+ hasConversionGoalFilter,+ isRealtime,+ isDetailed = false,+ isRevenueAvailable = false,+ detailedMetrics = DEFAULT_DETAILED_METRICS+}: {+ hasConversionGoalFilter: boolean+ isRealtime: boolean+ isDetailed?: boolean+ isRevenueAvailable?: boolean+ detailedMetrics?: Metric[]+}): Metric[] => {+ if (hasConversionGoalFilter && isDetailed && isRevenueAvailable) {+ return [+ 'total_visitors',+ 'visitors',+ 'group_conversion_rate',+ 'total_revenue',+ 'average_revenue'+ ]+ }+ if (hasConversionGoalFilter && isDetailed) {+ return ['total_visitors', 'visitors', 'group_conversion_rate']+ }+ if (hasConversionGoalFilter) {+ return ['visitors', 'group_conversion_rate']+ }+ if (isRealtime) {+ return ['visitors', 'percentage']+ }+ if (isDetailed) {+ return detailedMetrics+ }+ return ['visitors', 'percentage']+}++export function addDimensionSearchFilter(+ statsQuery: StatsQuery,+ dimension: string,+ search: string+) {+ return addFilter(statsQuery, [+ 'contains',+ dimension,+ [search],+ { case_sensitive: false }+ ] as ApiFilter)+}diff --git a/assets/js/dashboard/stats/devices/index.js b/assets/js/dashboard/stats/devices/index.jsindex f383821c2f..88757a15c3 100644--- a/assets/js/dashboard/stats/devices/index.js+++ b/assets/js/dashboard/stats/devices/index.js@@ -5,7 +5,7 @@ import {hasConversionGoalFilter,isFilteringOnFixedValue} from '../../util/filters'-import ListReport from '../reports/list'+import ListReport from '../reports/list-legacy'import * as metrics from '../reports/metrics'import * as api from '../../api'import * as url from '../../util/url'diff --git a/assets/js/dashboard/stats/graph/fetch-main-graph.ts b/assets/js/dashboard/stats/graph/fetch-main-graph.tsindex b944f6ed27..ff167c74f7 100644--- a/assets/js/dashboard/stats/graph/fetch-main-graph.ts+++ b/assets/js/dashboard/stats/graph/fetch-main-graph.ts@@ -1,9 +1,10 @@-import { Metric } from '../../../types/query-api'+import { Metric } from '../metrics'import { DashboardState } from '../../dashboard-state'import { DashboardPeriod } from '../../dashboard-time-periods'import { PlausibleSite } from '../../site-context'import { createStatsQuery, ReportParams } from '../../stats-query'import { isRealTimeDashboard } from '../../util/filters'+import { MetricValue } from '../../api'import * as api from '../../api'export function fetchMainGraph(@@ -35,20 +36,11 @@ export function fetchMainGraph(return api.stats(site, statsQuery)}-export type RevenueMetricValue = {- short: string- value: number- long: string- currency: string-}-export type ResultItem = {dimensions: [string] // one itemmetrics: MetricValues}-export type MetricValue = null | number | RevenueMetricValue-export type MetricValues = [MetricValue] // one itemexport type MainGraphResponse = {@@ -66,11 +58,5 @@ export type MainGraphResponse = {empty_metrics: MetricValuespresent_index: number}- query: {- interval: string- date_range: [string, string]- comparison_date_range?: [string, string]- dimensions: [string] // one item- metrics: [string] // one item- }+ query: api.QueryResultQuery}diff --git a/assets/js/dashboard/stats/graph/fetch-top-stats.test.ts b/assets/js/dashboard/stats/graph/fetch-top-stats.test.tsindex 00cd269f07..9d12a4663f 100644--- a/assets/js/dashboard/stats/graph/fetch-top-stats.test.ts+++ b/assets/js/dashboard/stats/graph/fetch-top-stats.test.ts@@ -1,4 +1,4 @@-import { Metric } from '../../../types/query-api'+import { Metric } from '../metrics'import {DashboardState,dashboardStateDefaultValue,@@ -30,17 +30,24 @@ const expectedBaseInclude: StatsQuery['include'] = {present_index: false}-const expectedRealtimeVisitorsQuery: StatsQuery = {- date_range: DashboardPeriod.realtime,+const expectedBaseQuery = {dimensions: [],filters: [],+ include: expectedBaseInclude,+ relative_date: null,+ order_by: null,+ pagination: null+}++const expectedRealtimeVisitorsQuery: StatsQuery = {+ ...expectedBaseQuery,+ date_range: DashboardPeriod.realtime,include: {...expectedBaseInclude,compare: null,imports_meta: false},- metrics: ['visitors'],- relative_date: null+ metrics: ['visitors']}type TestCase = [@@ -62,12 +69,11 @@ const cases: TestCase[] = [['visitors', 'events'],[{+ ...expectedBaseQuery,date_range: DashboardPeriod.realtime_30m,- dimensions: [],filters: remapToApiFilters([aGoalFilter]),include: { ...expectedBaseInclude, compare: null },- metrics: ['visitors', 'events'],- relative_date: null+ metrics: ['visitors', 'events']},expectedRealtimeVisitorsQuery]@@ -79,15 +85,13 @@ const cases: TestCase[] = [['visitors', 'pageviews'],[{+ ...expectedBaseQuery,date_range: DashboardPeriod.realtime_30m,- dimensions: [],- filters: [],include: {...expectedBaseInclude,compare: null},- metrics: ['visitors', 'pageviews'],- relative_date: null+ metrics: ['visitors', 'pageviews']},expectedRealtimeVisitorsQuery]@@ -111,18 +115,16 @@ const cases: TestCase[] = [],[{+ ...expectedBaseQuery,date_range: aPeriodNotRealtime,- dimensions: [],filters: remapToApiFilters([aGoalFilter]),- include: expectedBaseInclude,metrics: ['visitors','events','total_revenue','average_revenue','conversion_rate'- ],- relative_date: null+ ]},null]@@ -134,12 +136,10 @@ const cases: TestCase[] = [['visitors', 'events', 'conversion_rate'],[{+ ...expectedBaseQuery,date_range: aPeriodNotRealtime,- dimensions: [],filters: remapToApiFilters([aGoalFilter]),- include: expectedBaseInclude,- metrics: ['visitors', 'events', 'conversion_rate'],- relative_date: null+ metrics: ['visitors', 'events', 'conversion_rate']},null]@@ -162,10 +162,9 @@ const cases: TestCase[] = [[{+ ...expectedBaseQuery,date_range: aPeriodNotRealtime,- dimensions: [],filters: remapToApiFilters([aPageFilter]),- include: { ...expectedBaseInclude },metrics: ['visitors','visits',@@ -173,8 +172,7 @@ const cases: TestCase[] = ['bounce_rate','scroll_depth','time_on_page'- ],- relative_date: null+ ]},null]@@ -193,10 +191,8 @@ const cases: TestCase[] = [],[{+ ...expectedBaseQuery,date_range: aPeriodNotRealtime,- dimensions: [],- filters: [],- include: expectedBaseInclude,metrics: ['visitors','visits',@@ -204,8 +200,7 @@ const cases: TestCase[] = ['views_per_visit','bounce_rate','visit_duration'- ],- relative_date: null+ ]},null]@@ -274,6 +269,7 @@ function makeTopStatsResponse(return {query: {metrics: ['visitors'] as ['visitors'],+ dimensions: [],date_range: dateRange,comparison_date_range: comparisonDateRange as [string, string]},diff --git a/assets/js/dashboard/stats/graph/fetch-top-stats.ts b/assets/js/dashboard/stats/graph/fetch-top-stats.tsindex d8392f5095..d33b2331ba 100644--- a/assets/js/dashboard/stats/graph/fetch-top-stats.ts+++ b/assets/js/dashboard/stats/graph/fetch-top-stats.ts@@ -1,7 +1,6 @@-import { Metric } from '../../../types/query-api'import * as api from '../../api'import { DashboardState } from '../../dashboard-state'-import { getMetricLabel } from '../metrics'+import { Metric, getMetricLabel } from '../metrics'import {ComparisonMode,DashboardPeriod,@@ -141,7 +140,7 @@ function constructTopStatsQuery(type TopStatItem = {metric: Metric- value: number+ value: api.MetricValuename: stringgraphable: booleanchange?: numberdiff --git a/assets/js/dashboard/stats/graph/main-graph-data.ts b/assets/js/dashboard/stats/graph/main-graph-data.tsindex 9303d83ee3..3f34a9f73a 100644--- a/assets/js/dashboard/stats/graph/main-graph-data.ts+++ b/assets/js/dashboard/stats/graph/main-graph-data.ts@@ -1,4 +1,5 @@-import { MainGraphResponse, MetricValue, ResultItem } from './fetch-main-graph'+import { MainGraphResponse, ResultItem } from './fetch-main-graph'+import { MetricValue } from '../../api'/*** Fills gaps in @see MainGraphResponse the series of `results` and `comparisonResults`.diff --git a/assets/js/dashboard/stats/graph/main-graph.tsx b/assets/js/dashboard/stats/graph/main-graph.tsxindex 3092ee1fb6..d34b4dc468 100644--- a/assets/js/dashboard/stats/graph/main-graph.tsx+++ b/assets/js/dashboard/stats/graph/main-graph.tsx@@ -20,16 +20,12 @@ import {} from '../../util/date'import classNames from 'classnames'import { ChangeArrow } from '../reports/change-arrow'-import { Metric } from '../../../types/query-api'import { useAppNavigate } from '../../navigation/use-app-navigate'import { Graph, PointerHandler, SeriesConfig } from '../../components/graph'import { useSiteContext, PlausibleSite } from '../../site-context'import { GraphTooltipWrapper } from '../../components/graph-tooltip'-import {- MainGraphResponse,- MetricValue,- RevenueMetricValue-} from './fetch-main-graph'+import { MetricValue, RevenueMetricValue } from '../../api'+import { MainGraphResponse } from './fetch-main-graph'import {remapAndFillData,getLineSegments,@@ -41,7 +37,7 @@ import {getFirstAndLastTimeLabels,MainGraphSeriesName} from './main-graph-data'-import { getMetricLabel } from '../metrics'+import { Metric, getMetricLabel } from '../metrics'import { useDashboardStateContext } from '../../dashboard-state-context'import { hasConversionGoalFilter } from '../../util/filters'import { Interval } from './intervals'diff --git a/assets/js/dashboard/stats/graph/visitor-graph.tsx b/assets/js/dashboard/stats/graph/visitor-graph.tsxindex 2128ee71f5..97fa477dfa 100644--- a/assets/js/dashboard/stats/graph/visitor-graph.tsx+++ b/assets/js/dashboard/stats/graph/visitor-graph.tsx@@ -6,7 +6,7 @@ import { fetchMainGraph } from './fetch-main-graph'import { useDashboardStateContext } from '../../dashboard-state-context'import { PlausibleSite, useSiteContext } from '../../site-context'import { useQuery, useQueryClient } from '@tanstack/react-query'-import { Metric } from '../../../types/query-api'+import { Metric } from '../metrics'import { DashboardPeriod } from '../../dashboard-time-periods'import { DashboardState } from '../../dashboard-state'import { getStaleTime } from '../../hooks/api-client'diff --git a/assets/js/dashboard/stats/locations/index.js b/assets/js/dashboard/stats/locations/index.jsindex 1421f4d421..b083a2da16 100644--- a/assets/js/dashboard/stats/locations/index.js+++ b/assets/js/dashboard/stats/locations/index.js@@ -5,7 +5,7 @@ import CountriesMap from './map'import * as api from '../../api'import { apiPath } from '../../util/url'-import ListReport from '../reports/list'+import ListReport from '../reports/list-legacy'import * as metrics from '../reports/metrics'import {hasConversionGoalFilter,diff --git a/assets/js/dashboard/stats/locations/map.tsx b/assets/js/dashboard/stats/locations/map.tsxindex 33dd356aac..60b0bdfdda 100644--- a/assets/js/dashboard/stats/locations/map.tsx+++ b/assets/js/dashboard/stats/locations/map.tsx@@ -17,7 +17,7 @@ import { useDashboardStateContext } from '../../dashboard-state-context'import worldJson from 'visionscarto-world-atlas/world/110m.json'import { UIMode, useTheme } from '../../theme-context'import { apiPath } from '../../util/url'-import { MIN_HEIGHT } from '../reports/list'+import { MIN_HEIGHT } from '../reports/list-legacy'import { MapTooltip } from './map-tooltip'import { GeolocationNotice } from './geolocation-notice'import { DashboardState } from '../../dashboard-state'diff --git a/assets/js/dashboard/stats/metrics.test.ts b/assets/js/dashboard/stats/metrics.test.tsnew file mode 100644index 0000000000..a28120fc1a--- /dev/null+++ b/assets/js/dashboard/stats/metrics.test.ts@@ -0,0 +1,261 @@+import {+ isSortable,+ getMetricLabel,+ getBreakdownMetricLabel,+ Metric+} from './metrics'++describe(`${isSortable.name}`, () => {+ it('returns false for total_visitors', () => {+ expect(isSortable('total_visitors')).toBe(false)+ })++ const sortableMetrics: Metric[] = [+ 'visitors',+ 'visits',+ 'pageviews',+ 'views_per_visit',+ 'bounce_rate',+ 'visit_duration',+ 'events',+ 'percentage',+ 'conversion_rate',+ 'group_conversion_rate',+ 'time_on_page',+ 'total_revenue',+ 'average_revenue',+ 'scroll_depth',+ 'exit_rate'+ ]++ it.each(sortableMetrics)('returns true for %s', (metric) => {+ expect(isSortable(metric)).toBe(true)+ })+})++describe(`${getMetricLabel.name}`, () => {+ it.each([+ ['visitors', false, 'Unique visitors'],+ ['visitors', true, 'Unique conversions'],+ ['events', false, 'Total events'],+ ['events', true, 'Total conversions'],+ ['visits', false, 'Total visits'],+ ['pageviews', false, 'Total pageviews'],+ ['views_per_visit', false, 'Views per visit'],+ ['bounce_rate', false, 'Bounce rate'],+ ['visit_duration', false, 'Visit duration'],+ ['time_on_page', false, 'Time on page'],+ ['scroll_depth', false, 'Scroll depth'],+ ['conversion_rate', false, 'Conversion rate'],+ ['total_revenue', false, 'Total revenue'],+ ['average_revenue', false, 'Average revenue'],+ ['percentage', false, 'Percentage'],+ ['group_conversion_rate', false, 'Conversion rate'],+ ['total_visitors', false, 'Total visitors'],+ ['exit_rate', false, 'Exit rate']+ ] as const)(+ '%s (hasConversionGoalFilter=%s) -> %s',+ (metric, hasConversionGoalFilter, expected) => {+ expect(getMetricLabel(metric, { hasConversionGoalFilter })).toBe(expected)+ }+ )+})++describe(`${getBreakdownMetricLabel.name}`, () => {+ const defaults = { hasConversionGoalFilter: false, isRealtime: false }++ describe('entry page dimension', () => {+ const dimension = 'visit:entry_page'++ it('returns Unique entrances for visitors (no goal, not realtime)', () => {+ expect(+ getBreakdownMetricLabel('visitors', {+ ...defaults,+ dimensions: [dimension]+ })+ ).toBe('Unique entrances')+ })++ it('returns Total entrances for visits (no goal, not realtime)', () => {+ expect(+ getBreakdownMetricLabel('visits', {+ ...defaults,+ dimensions: [dimension]+ })+ ).toBe('Total entrances')+ })++ it('falls back to default label for visitors with conversion goal', () => {+ expect(+ getBreakdownMetricLabel('visitors', {+ hasConversionGoalFilter: true,+ isRealtime: false,+ dimensions: [dimension]+ })+ ).toBe('Conversions')+ })++ it('falls back to default label for visitors in realtime', () => {+ expect(+ getBreakdownMetricLabel('visitors', {+ hasConversionGoalFilter: false,+ isRealtime: true,+ dimensions: [dimension]+ })+ ).toBe('Current visitors')+ })++ it('falls back to default label for other metrics', () => {+ expect(+ getBreakdownMetricLabel('bounce_rate', {+ ...defaults,+ dimensions: [dimension]+ })+ ).toBe('Bounce rate')+ })+ })++ describe('exit page dimension', () => {+ const dimension = 'visit:exit_page'++ it('returns Unique exits for visitors (no goal, not realtime)', () => {+ expect(+ getBreakdownMetricLabel('visitors', {+ ...defaults,+ dimensions: [dimension]+ })+ ).toBe('Unique exits')+ })++ it('returns Total exits for visits (no goal, not realtime)', () => {+ expect(+ getBreakdownMetricLabel('visits', {+ ...defaults,+ dimensions: [dimension]+ })+ ).toBe('Total exits')+ })++ it('falls back to default label for visitors with conversion goal', () => {+ expect(+ getBreakdownMetricLabel('visitors', {+ hasConversionGoalFilter: true,+ isRealtime: false,+ dimensions: [dimension]+ })+ ).toBe('Conversions')+ })++ it('falls back to default label for visitors in realtime', () => {+ expect(+ getBreakdownMetricLabel('visitors', {+ hasConversionGoalFilter: false,+ isRealtime: true,+ dimensions: [dimension]+ })+ ).toBe('Current visitors')+ })++ it('falls back to default label for other metrics', () => {+ expect(+ getBreakdownMetricLabel('exit_rate', {+ ...defaults,+ dimensions: [dimension]+ })+ ).toBe('Exit rate')+ })+ })++ describe('goal dimension', () => {+ const dimension = 'event:goal'++ it('returns Uniques for visitors', () => {+ expect(+ getBreakdownMetricLabel('visitors', {+ ...defaults,+ dimensions: [dimension]+ })+ ).toBe('Uniques')+ })++ it('returns Total for events', () => {+ expect(+ getBreakdownMetricLabel('events', {+ ...defaults,+ dimensions: [dimension]+ })+ ).toBe('Total')+ })++ it('returns CR for conversion_rate', () => {+ expect(+ getBreakdownMetricLabel('conversion_rate', {+ ...defaults,+ dimensions: [dimension]+ })+ ).toBe('CR')+ })++ it('falls back to default label for other metrics', () => {+ expect(+ getBreakdownMetricLabel('bounce_rate', {+ ...defaults,+ dimensions: [dimension]+ })+ ).toBe('Bounce rate')+ })+ })++ describe('any other session dimension', () => {+ const dimensions = ['visit:source']++ it('returns Visitors for visitors (no goal, not realtime)', () => {+ expect(+ getBreakdownMetricLabel('visitors', { ...defaults, dimensions })+ ).toBe('Visitors')+ })++ it('returns Conversions for visitors with conversion goal', () => {+ expect(+ getBreakdownMetricLabel('visitors', {+ hasConversionGoalFilter: true,+ isRealtime: false,+ dimensions+ })+ ).toBe('Conversions')+ })++ it('returns Current visitors for visitors in realtime', () => {+ expect(+ getBreakdownMetricLabel('visitors', {+ hasConversionGoalFilter: false,+ isRealtime: true,+ dimensions+ })+ ).toBe('Current visitors')+ })++ it.each([+ ['group_conversion_rate', 'CR'],+ ['conversion_rate', 'CR'],+ ['pageviews', 'Pageviews'],+ ['average_revenue', 'Average'],+ ['total_revenue', 'Revenue']+ ] as const)('%s -> %s', (metric, expected) => {+ expect(getBreakdownMetricLabel(metric, { ...defaults, dimensions })).toBe(+ expected+ )+ })++ it.each([+ 'visits',+ 'views_per_visit',+ 'bounce_rate',+ 'visit_duration'+ ] as const)('delegates to getMetricLabel for %s', (metric) => {+ expect(getBreakdownMetricLabel(metric, { ...defaults, dimensions })).toBe(+ getMetricLabel(metric, defaults)+ )+ })+ })+})diff --git a/assets/js/dashboard/stats/metrics.ts b/assets/js/dashboard/stats/metrics.tsindex 2a66eff70e..6df7caf94a 100644--- a/assets/js/dashboard/stats/metrics.ts+++ b/assets/js/dashboard/stats/metrics.ts@@ -1,4 +1,28 @@-import { Metric } from '../../types/query-api'+import { Metric as PublicApiMetric } from '../../types/query-api'++export type Metric = PublicApiMetric | 'total_visitors' | 'exit_rate'++const SORTABLE = [+ 'visitors',+ 'visits',+ 'pageviews',+ 'views_per_visit',+ 'bounce_rate',+ 'visit_duration',+ 'events',+ 'percentage',+ 'conversion_rate',+ 'group_conversion_rate',+ 'time_on_page',+ 'total_revenue',+ 'average_revenue',+ 'scroll_depth',+ 'exit_rate'+]++export const isSortable = (metric: Metric): boolean => {+ return SORTABLE.includes(metric)+}export const getMetricLabel = (metric: Metric,@@ -33,5 +57,125 @@ export const getMetricLabel = (return 'Percentage'case 'group_conversion_rate':return 'Conversion rate'+ case 'total_visitors':+ return 'Total visitors'+ case 'exit_rate':+ return 'Exit rate'+ }+}++export const getBreakdownMetricLabel = (+ metric: Metric,+ {+ hasConversionGoalFilter,+ isRealtime,+ dimensions+ }: {+ hasConversionGoalFilter: boolean+ isRealtime: boolean+ dimensions: string[]+ }+): string => {+ switch (dimensions[0]) {+ case 'visit:entry_page':+ return getEntryPagesBreakdownMetricLabel(metric, {+ hasConversionGoalFilter,+ isRealtime+ })+ case 'visit:exit_page':+ return getExitPagesBreakdownMetricLabel(metric, {+ hasConversionGoalFilter,+ isRealtime+ })+ case 'event:goal':+ return getConversionsBreakdownMetricLabel(metric)+ default:+ return getDefaultBreakdownMetricLabel(metric, {+ hasConversionGoalFilter,+ isRealtime+ })+ }+}++const getEntryPagesBreakdownMetricLabel = (+ metric: Metric,+ {+ hasConversionGoalFilter,+ isRealtime+ }: { hasConversionGoalFilter: boolean; isRealtime: boolean }+): string => {+ if (metric === 'visitors' && !hasConversionGoalFilter && !isRealtime) {+ return 'Unique entrances'+ }+ if (metric === 'visits' && !hasConversionGoalFilter && !isRealtime) {+ return 'Total entrances'+ }++ return getDefaultBreakdownMetricLabel(metric, {+ hasConversionGoalFilter,+ isRealtime+ })+}++const getExitPagesBreakdownMetricLabel = (+ metric: Metric,+ {+ hasConversionGoalFilter,+ isRealtime+ }: { hasConversionGoalFilter: boolean; isRealtime: boolean }+): string => {+ if (metric === 'visitors' && !hasConversionGoalFilter && !isRealtime) {+ return 'Unique exits'+ }+ if (metric === 'visits' && !hasConversionGoalFilter && !isRealtime) {+ return 'Total exits'+ }++ return getDefaultBreakdownMetricLabel(metric, {+ hasConversionGoalFilter,+ isRealtime+ })+}++const getConversionsBreakdownMetricLabel = (metric: Metric): string => {+ switch (metric) {+ case 'visitors':+ return 'Uniques'+ case 'events':+ return 'Total'+ default:+ return getDefaultBreakdownMetricLabel(metric, {+ hasConversionGoalFilter: false,+ isRealtime: false+ })+ }+}++const getDefaultBreakdownMetricLabel = (+ metric: Metric,+ {+ hasConversionGoalFilter,+ isRealtime+ }: { hasConversionGoalFilter: boolean; isRealtime: boolean }+): string => {+ switch (metric) {+ case 'visitors':+ return hasConversionGoalFilter+ ? 'Conversions'+ : isRealtime+ ? 'Current visitors'+ : 'Visitors'+ case 'group_conversion_rate':+ return 'CR'+ case 'conversion_rate':+ return 'CR'+ case 'average_revenue':+ return 'Average'+ case 'total_revenue':+ return 'Revenue'+ case 'pageviews':+ return 'Pageviews'+ default:+ return getMetricLabel(metric, { hasConversionGoalFilter })}}diff --git a/assets/js/dashboard/stats/modals/breakdown-modal.tsx b/assets/js/dashboard/stats/modals/breakdown-modal-legacy.tsxsimilarity index 97%rename from assets/js/dashboard/stats/modals/breakdown-modal.tsxrename to assets/js/dashboard/stats/modals/breakdown-modal-legacy.tsxindex 04d3e4f65a..7189784fc3 100644--- a/assets/js/dashboard/stats/modals/breakdown-modal.tsx+++ b/assets/js/dashboard/stats/modals/breakdown-modal-legacy.tsx@@ -9,15 +9,15 @@ import {OrderBy,useOrderBy,useRememberOrderBy-} from '../../hooks/use-order-by'+} from '../../hooks/use-order-by-legacy'import { Metric } from '../reports/metrics'import * as metricsModule from '../reports/metrics'import { BreakdownResultMeta, DashboardState } from '../../dashboard-state'-import { ColumnConfiguraton } from '../../components/table'-import { BreakdownTable } from './breakdown-table'+import { ColumnConfiguraton } from '../../components/table-legacy'+import { BreakdownTable } from './breakdown-table-legacy'import { useSiteContext } from '../../site-context'import { DrilldownLink, FilterInfo } from '../../components/drilldown-link'-import { SharedReportProps } from '../reports/list'+import { SharedReportProps } from '../reports/list-legacy'import { hasConversionGoalFilter } from '../../util/filters'export type ReportInfo = {diff --git a/assets/js/dashboard/stats/modals/breakdown-modal.test.tsx b/assets/js/dashboard/stats/modals/breakdown-modal.test.tsxindex 55e56447b2..46d50a57f4 100644--- a/assets/js/dashboard/stats/modals/breakdown-modal.test.tsx+++ b/assets/js/dashboard/stats/modals/breakdown-modal.test.tsx@@ -1,7 +1,7 @@import React, { useState, Dispatch, SetStateAction } from 'react'import { act, render, screen } from '@testing-library/react'import { TestContextProviders } from '../../../../test-utils/app-context-providers'-import PagesModal from './pages'+import BrowsersModal from './devices/browsers-modal'import { MockAPI } from '../../../../test-utils/mock-api'const domain = 'dummy.site'@@ -37,14 +37,17 @@ describe('BreakdownModal', () => {meta: { date_range_label: 'Last 30 days', metric_warnings: undefined }}- const pagesHandler = mockAPI.get(`/api/stats/${domain}/pages/`, response)+ const browsersHandler = mockAPI.get(+ `/api/stats/${domain}/browsers/`,+ response+ )let setOpen: Dispatch<SetStateAction<boolean>>function ToggleableModal() {const [open, s] = useState(false)setOpen = s- return open ? <PagesModal /> : null+ return open ? <BrowsersModal /> : null}render(@@ -53,11 +56,11 @@ describe('BreakdownModal', () => {</TestContextProviders>)- expect(pagesHandler).toHaveBeenCalledTimes(0)+ expect(browsersHandler).toHaveBeenCalledTimes(0)act(() => setOpen(true))- expect(screen.getByText('Top pages')).toBeVisible()- expect(pagesHandler).toHaveBeenCalledTimes(1)- expect(pagesHandler).toHaveBeenNthCalledWith(+ expect(screen.getByText('Browsers')).toBeVisible()+ expect(browsersHandler).toHaveBeenCalledTimes(1)+ expect(browsersHandler).toHaveBeenNthCalledWith(1,expect.stringContaining('order_by=%5B%5B%22visitors%22%2C%22desc%22%5D%5D&limit=100&page=1'@@ -66,10 +69,10 @@ describe('BreakdownModal', () => {)act(() => setOpen(false))- expect(screen.queryByText('Top pages')).not.toBeInTheDocument()+ expect(screen.queryByText('Browsers')).not.toBeInTheDocument()act(() => setOpen(true))- expect(screen.getByText('Top pages')).toBeVisible()+ expect(screen.getByText('Browsers')).toBeVisible()- expect(pagesHandler).toHaveBeenCalledTimes(1)+ expect(browsersHandler).toHaveBeenCalledTimes(1)})})diff --git a/assets/js/dashboard/stats/modals/breakdown-table-legacy.tsx b/assets/js/dashboard/stats/modals/breakdown-table-legacy.tsxnew file mode 100644index 0000000000..18ca9cde25--- /dev/null+++ b/assets/js/dashboard/stats/modals/breakdown-table-legacy.tsx@@ -0,0 +1,134 @@+import React, { ReactNode, useRef } from 'react'+import { XMarkIcon } from '@heroicons/react/20/solid'++import { SearchInput } from '../../components/search-input'+import { ColumnConfiguraton, Table } from '../../components/table-legacy'+import RocketIcon from './rocket-icon'+import { QueryStatus } from '@tanstack/react-query'+import { useAppNavigate } from '../../navigation/use-app-navigate'+import { rootRoute } from '../../router'++export const BreakdownTable = <TListItem extends { name: string }>({+ title,+ isPending,+ isFetching,+ onSearch,+ hasNextPage,+ isFetchingNextPage,+ fetchNextPage,+ columns,+ data,+ status,+ error,+ displayError,+ onClose+}: {+ title: ReactNode+ onSearch?: (input: string) => void+ isPending: boolean+ isFetching: boolean+ hasNextPage: boolean+ isFetchingNextPage: boolean+ fetchNextPage: () => void+ columns: ColumnConfiguraton<TListItem>[]+ data?: { pages: TListItem[][] }+ status?: QueryStatus+ error?: Error | null+ /** Controls whether the component displays API request errors or ignores them. */+ displayError?: boolean+ onClose?: () => void+}) => {+ const searchRef = useRef<HTMLInputElement>(null)+ const navigate = useAppNavigate()+ const handleClose =+ onClose ?? (() => navigate({ path: rootRoute.path, search: (s) => s }))++ return (+ <div className="min-h-[66vh] md:min-h-120 flex flex-col flex-1">+ <div className="flex justify-between items-center gap-4">+ <div className="flex items-center gap-4 w-full">+ <h1 className="shrink-0 mb-0.5 text-base md:text-lg font-bold dark:text-gray-100">+ {title}+ </h1>+ {!!onSearch && (+ <SearchInput+ searchRef={searchRef}+ onSearch={onSearch}+ className={+ displayError && status === 'error'+ ? '[&_input]:pointer-events-none'+ : ''+ }+ />+ )}+ {!isPending && isFetching && <SmallLoadingSpinner />}+ </div>+ <button+ type="button"+ onClick={handleClose}+ aria-label="Close modal"+ className="text-gray-400 hover:text-gray-600 dark:text-gray-500 dark:hover:text-gray-300"+ >+ <XMarkIcon className="size-5" />+ </button>+ </div>+ <div className="my-3 md:my-4 border-b border-gray-250 dark:border-gray-750"></div>+ <div className="flex-1 overflow-auto pr-4 -mr-4">+ {displayError && status === 'error' && <ErrorMessage error={error} />}+ {isPending && <InitialLoadingSpinner />}+ {data && <Table<TListItem> data={data} columns={columns} />}+ {!isPending && !isFetching && hasNextPage && (+ <LoadMore+ onClick={() => fetchNextPage()}+ isFetchingNextPage={isFetchingNextPage}+ />+ )}+ </div>+ </div>+ )+}++const InitialLoadingSpinner = () => (+ <div className="w-full h-full flex flex-col justify-center">+ <div className="mx-auto loading">+ <div />+ </div>+ </div>+)++const SmallLoadingSpinner = () => (+ <div className="loading sm">+ <div />+ </div>+)++const ErrorMessage = ({ error }: { error?: unknown }) => (+ <div className="grid grid-rows-2 text-gray-700 dark:text-gray-300">+ <div className="text-center self-end">+ <RocketIcon />+ </div>+ <div className="text-lg text-center">+ {error+ ? (error as { message: string }).message+ : 'Error loading data. Refresh the page to try again'}+ </div>+ </div>+)++const LoadMore = ({+ onClick,+ isFetchingNextPage+}: {+ onClick: () => void+ isFetchingNextPage: boolean+}) => (+ <div className="flex flex-col w-full my-4 items-center justify-center h-10">+ {isFetchingNextPage ? (+ <SmallLoadingSpinner />+ ) : (+ <button onClick={onClick} type="button" className="button">+ Load more+ </button>+ )}+ </div>+)diff --git a/assets/js/dashboard/stats/modals/breakdown-table.tsx b/assets/js/dashboard/stats/modals/breakdown-table.tsxindex 878bd0b782..e8f0468681 100644--- a/assets/js/dashboard/stats/modals/breakdown-table.tsx+++ b/assets/js/dashboard/stats/modals/breakdown-table.tsx@@ -2,13 +2,14 @@ import React, { ReactNode, useRef } from 'react'import { XMarkIcon } from '@heroicons/react/20/solid'import { SearchInput } from '../../components/search-input'-import { ColumnConfiguraton, Table } from '../../components/table'+import { Table } from '../../components/table'+import { ColumnConfiguration } from '../breakdowns'import RocketIcon from './rocket-icon'import { QueryStatus } from '@tanstack/react-query'import { useAppNavigate } from '../../navigation/use-app-navigate'import { rootRoute } from '../../router'-export const BreakdownTable = <TListItem extends { name: string }>({+export function BreakdownTable<T>({title,isPending,isFetching,@@ -20,8 +21,9 @@ export const BreakdownTable = <TListItem extends { name: string }>({data,status,error,- displayError,- onClose+ displayError = true,+ onClose,+ getRowKey}: {title: ReactNodeonSearch?: (input: string) => void@@ -30,14 +32,15 @@ export const BreakdownTable = <TListItem extends { name: string }>({hasNextPage: booleanisFetchingNextPage: booleanfetchNextPage: () => void- columns: ColumnConfiguraton<TListItem>[]- data?: { pages: TListItem[][] }+ columns: ColumnConfiguration<T>[] | null+ data?: { pages: T[][] }status?: QueryStatuserror?: Error | null/** Controls whether the component displays API request errors or ignores them. */displayError?: booleanonClose?: () => void-}) => {+ getRowKey: (row: T) => string+}) {const searchRef = useRef<HTMLInputElement>(null)const navigate = useAppNavigate()const handleClose =@@ -50,7 +53,7 @@ export const BreakdownTable = <TListItem extends { name: string }>({<h1 className="shrink-0 mb-0.5 text-base md:text-lg font-bold dark:text-gray-100">{title}</h1>- {!!onSearch && (+ {typeof onSearch === 'function' && (<SearchInputsearchRef={searchRef}onSearch={onSearch}@@ -76,7 +79,9 @@ export const BreakdownTable = <TListItem extends { name: string }>({<div className="flex-1 overflow-auto pr-4 -mr-4">{displayError && status === 'error' && <ErrorMessage error={error} />}{isPending && <InitialLoadingSpinner />}- {data && <Table<TListItem> data={data} columns={columns} />}+ {columns && data && (+ <Table data={data} columns={columns} getRowKey={getRowKey} />+ )}{!isPending && !isFetching && hasNextPage && (<LoadMoreonClick={() => fetchNextPage()}diff --git a/assets/js/dashboard/stats/modals/conversions.js b/assets/js/dashboard/stats/modals/conversions.jsindex 92d6834f1b..b5e3e523ec 100644--- a/assets/js/dashboard/stats/modals/conversions.js+++ b/assets/js/dashboard/stats/modals/conversions.js@@ -1,7 +1,7 @@import React, { useCallback, useState } from 'react'import Modal from './modal'-import BreakdownModal from './breakdown-modal'+import BreakdownModal from './breakdown-modal-legacy'import * as metrics from '../reports/metrics'import * as url from '../../util/url'import { useSiteContext } from '../../site-context'diff --git a/assets/js/dashboard/stats/modals/details-breakdown.tsx b/assets/js/dashboard/stats/modals/details-breakdown.tsxnew file mode 100644index 0000000000..47b7b26480--- /dev/null+++ b/assets/js/dashboard/stats/modals/details-breakdown.tsx@@ -0,0 +1,518 @@+import React, {+ ReactNode,+ useCallback,+ useEffect,+ useMemo,+ useState+} from 'react'+import { useDashboardStateContext } from '../../dashboard-state-context'+import { usePaginatedQueryAPI } from '../../hooks/api-client'+import { rootRoute } from '../../router'+import {+ getStoredOrderBy,+ Order,+ OrderBy,+ SortDirection,+ useOrderBy,+ useRememberOrderBy+} from '../../hooks/use-order-by'+import { Metric, getBreakdownMetricLabel, isSortable } from '../metrics'+import { BreakdownTable } from './breakdown-table'+import { createStatsQuery, StatsQuery } from '../../stats-query'+import { useSiteContext } from '../../site-context'+import { DrilldownLink, FilterInfo } from '../../components/drilldown-link'+import {+ ColumnConfiguration,+ ExternalLinkIcon,+ MetricValueTooltipContent,+ SharedBreakdownReportProps,+ formatDateRangeLabel,+ useBodyPortalRef,+ extractMetricValue+} from '../breakdowns'+import {+ QueryResultRow,+ QueryResultMeta,+ QueryResultQuery,+ QueryApiResponse+} from '../../api'+import classNames from 'classnames'+import { Tooltip } from '../../util/tooltip'+import { ChangeArrow } from '../reports/change-arrow'+import {+ MetricFormatterShort,+ MetricFormatterLong+} from '../reports/metric-formatter'+import {+ hasConversionGoalFilter,+ isRealTimeDashboard+} from '../../util/filters'+import { SortButton } from '../../components/sort-button'++type PaginatedData = { pages: QueryApiResponse[] }++type DetailsBreakdownProps = SharedBreakdownReportProps & {+ title: ReactNode+ defaultOrderBy?: OrderBy+ addSearchFilter?: (statsQuery: StatsQuery, search: string) => StatsQuery+ onDataReady?: (data: PaginatedData) => void+}++const getMetricCellWidthClass = (+ metric: Metric,+ metricLabel: string+): string => {+ if (['average_revenue', 'total_revenue'].includes(metric)) {+ return 'w-32 min-w-32'+ }++ if (metricLabel.length < 3) {+ return 'w-28 min-w-28 md:w-24 md:min-w-24'+ }++ if (metricLabel.length < 15) {+ return 'w-28 min-w-28'+ }++ return 'w-32 min-w-32'+}++export function DetailsBreakdown({+ title,+ dimensionLabel,+ dimensions,+ metrics,+ defaultOrderBy = [] as OrderBy,+ getFilterInfo,+ getExternalLinkUrl,+ addSearchFilter,+ onDataReady+}: DetailsBreakdownProps) {+ const site = useSiteContext()+ const { dashboardState } = useDashboardStateContext()+ const [search, setSearch] = useState('')++ const storedOrderBy = getStoredOrderBy({+ domain: site.domain,+ dimensionLabel,+ metrics,+ fallbackValue: defaultOrderBy+ })++ const { orderBy, orderByDictionary, toggleSortByMetric } = useOrderBy({+ metrics,+ defaultOrderBy: storedOrderBy+ })++ useRememberOrderBy({+ effectiveOrderBy: orderBy,+ metrics,+ dimensionLabel+ })++ const effectiveOrderBy = (orderBy.length ? orderBy : storedOrderBy).concat(+ dimensions.map((dim) => [dim, SortDirection.asc])+ )++ const baseStatsQuery: StatsQuery = useMemo(+ () =>+ createStatsQuery(dashboardState, {+ metrics: metrics,+ dimensions,+ order_by: effectiveOrderBy as Order[]+ }),+ [dashboardState, metrics, dimensions, effectiveOrderBy]+ )++ const statsQuery: StatsQuery = useMemo(() => {+ if (search && addSearchFilter) {+ return addSearchFilter(baseStatsQuery, search)+ }+ return baseStatsQuery+ }, [baseStatsQuery, search, addSearchFilter])++ const apiState = usePaginatedQueryAPI({+ site,+ dashboardState,+ statsQuery+ })++ useEffect(() => {+ const pages = apiState.data?.pages+ if (pages?.length) {+ onDataReady?.({ pages })+ }+ }, [apiState.data, onDataReady])++ const query: QueryResultQuery | null =+ apiState.data?.pages?.[0]?.query ?? null++ const meta: QueryResultMeta | null =+ (apiState.data?.pages?.[0]?.meta as QueryResultMeta) ?? null++ const metricLabelFor = useCallback(+ (metric: Metric): string => {+ return getBreakdownMetricLabel(metric, {+ hasConversionGoalFilter: hasConversionGoalFilter(dashboardState),+ isRealtime: isRealTimeDashboard(dashboardState),+ dimensions: dimensions+ })+ },+ [dashboardState, dimensions]+ )++ const columns: ColumnConfiguration<QueryResultRow>[] | null = useMemo(() => {+ if (!query) return null++ const hasPercentage = query.metrics.includes('percentage')+ const isVisitorsWithPercentageCell = (m: Metric) =>+ hasPercentage && m === 'visitors'++ return [+ {+ key: 'dimension',+ renderLabel: () => dimensionLabel,+ renderCell: (row, isActive) => (+ <DimensionCell+ row={row}+ getFilterInfo={getFilterInfo}+ getExternalLinkUrl={getExternalLinkUrl}+ isActive={isActive}+ />+ ),+ width: 'w-48 max-w-48 md:w-56 md:max-w-56',+ align: 'left'+ },+ ...query.metrics+ // Percentage is not its own column — shown inline in the visitors cell+ .filter((metric) => metric !== 'percentage')+ .map(+ (metric): ColumnConfiguration<QueryResultRow> => ({+ key: metric,+ renderLabel: () => (+ <MetricLabel+ label={metricLabelFor(metric)}+ warning={getMetricWarning(metric, meta)}+ sortable={isSortable(metric)}+ toggleSort={() => toggleSortByMetric(metric)}+ sortDirection={orderByDictionary[metric] ?? null}+ />+ ),+ renderCell: (row, isActive) => {+ if (isVisitorsWithPercentageCell(metric)) {+ return (+ <VisitorsWithPercentageCell+ row={row}+ query={query}+ isActive={isActive}+ />+ )+ } else {+ return (+ <MetricValueCell+ row={row}+ metric={metric}+ metricLabel={metricLabelFor(metric)}+ query={query}+ isActive={isActive}+ />+ )+ }+ },+ onSort: isSortable(metric)+ ? () => toggleSortByMetric(metric)+ : undefined,+ sortDirection: orderByDictionary[metric],+ width: isVisitorsWithPercentageCell(metric)+ ? 'w-36'+ : getMetricCellWidthClass(metric, metricLabelFor(metric)),+ align: 'right'+ })+ )+ ]+ }, [+ dimensionLabel,+ query,+ meta,+ getFilterInfo,+ getExternalLinkUrl,+ orderByDictionary,+ toggleSortByMetric,+ metricLabelFor+ ])++ const tableData = apiState.data+ ? { pages: apiState.data.pages.map((p) => p.results) }+ : undefined++ return (+ <BreakdownTable<QueryResultRow>+ title={title}+ {...apiState}+ data={tableData}+ columns={columns}+ onSearch={addSearchFilter ? setSearch : undefined}+ getRowKey={(row) => row.dimensions[0]}+ />+ )+}++function VisitorsWithPercentageCell({+ row,+ query,+ isActive+}: {+ row: QueryResultRow+ query: QueryResultQuery+ isActive?: boolean+}) {+ const portalRef = useBodyPortalRef()++ const { value: visitorsValue, comparison: visitorsComparison } =+ extractMetricValue(row, query, 'visitors')+ const { value: percentageValue } = extractMetricValue(+ row,+ query,+ 'percentage'+ )++ const visitorsShortFormatter = MetricFormatterShort['visitors']+ const visitorsLongFormatter = MetricFormatterLong['visitors']+ const percentageFormatter = MetricFormatterShort['percentage']++ const showTooltip = !!visitorsComparison++ const dateRangeLabel = formatDateRangeLabel(query.date_range)+ const comparisonDateRangeLabel = query.comparison_date_range+ ? formatDateRangeLabel(query.comparison_date_range)+ : null++ const percentageCell = (+ <span+ className={classNames('mr-3 text-gray-500 dark:text-gray-400', {+ invisible: !isActive+ })}+ >+ {percentageFormatter(percentageValue)}+ </span>+ )++ const visitorsCell = (+ <span data-testid="metric-value">+ {isActive+ ? visitorsLongFormatter(visitorsValue)+ : visitorsShortFormatter(visitorsValue)}+ {visitorsComparison && (+ <ChangeArrow+ change={visitorsComparison.change}+ metric={'visitors'}+ className="inline-block pl-1 w-4"+ hideNumber+ />+ )}+ </span>+ )++ const visitorsWithTooltip = showTooltip ? (+ <Tooltip+ containerRef={portalRef as React.RefObject<HTMLElement>}+ info={+ <MetricValueTooltipContent+ value={visitorsValue}+ comparison={visitorsComparison}+ metric={'visitors'}+ metricLabel="Visitors"+ dateRangeLabel={dateRangeLabel}+ comparisonDateRangeLabel={comparisonDateRangeLabel}+ />+ }+ >+ {visitorsCell}+ </Tooltip>+ ) : (+ visitorsCell+ )++ return (+ <div className={'flex justify-end'}>+ {percentageCell}+ {visitorsWithTooltip}+ </div>+ )+}++function MetricValueCell({+ row,+ metric,+ metricLabel,+ query,+ isActive+}: {+ row: QueryResultRow+ metric: Metric+ metricLabel: string+ query: QueryResultQuery+ isActive?: boolean+}) {+ const portalRef = useBodyPortalRef()++ const { value, comparison } = extractMetricValue(row, query, metric)++ const shortFormatter = MetricFormatterShort[metric]+ const longFormatter = MetricFormatterLong[metric]++ // Show long format when the row is active (hovered on desktop, tapped on mobile)+ const displayFormatter = isActive ? longFormatter : shortFormatter++ // Tooltip is used for comparison mode only+ const showTooltip = !!comparison++ const valueContent = (+ <span+ className={classNames(+ 'font-medium text-sm text-gray-800 dark:text-gray-200',+ showTooltip && 'cursor-default'+ )}+ data-testid="metric-value"+ >+ {displayFormatter(value)}+ {comparison && (+ <ChangeArrow+ change={comparison.change}+ metric={metric}+ className="inline-block pl-1 w-4"+ hideNumber+ />+ )}+ </span>+ )++ if (!showTooltip) return valueContent++ const dateRangeLabel = formatDateRangeLabel(query.date_range)+ const comparisonDateRangeLabel = query.comparison_date_range+ ? formatDateRangeLabel(query.comparison_date_range)+ : null++ return (+ <Tooltip+ containerRef={portalRef as React.RefObject<HTMLElement>}+ info={+ <MetricValueTooltipContent+ value={value}+ comparison={comparison}+ metric={metric}+ metricLabel={metricLabel}+ dateRangeLabel={dateRangeLabel}+ comparisonDateRangeLabel={comparisonDateRangeLabel}+ />+ }+ >+ {valueContent}+ </Tooltip>+ )+}++function getMetricWarning(+ metricKey: string,+ meta: QueryResultMeta | null+): string | null {+ const warnings = meta?.metric_warnings+ if (!warnings || !warnings[metricKey]) return null+ const { code, message } = warnings[metricKey]+ if (metricKey === 'bounce_rate' && code === 'no_imported_bounce_rate') {+ return 'Does not include imported data'+ }+ if (metricKey === 'scroll_depth' && code === 'no_imported_scroll_depth') {+ return 'Does not include imported data'+ }+ if (metricKey === 'time_on_page' && code) {+ return message+ }+ return null+}++function MetricLabel({+ label,+ warning,+ sortable,+ toggleSort,+ sortDirection+}: {+ label: string+ warning: string | null+ sortable: boolean+ toggleSort: () => void+ sortDirection: SortDirection | null+}) {+ const labelText = label + (warning ? ' *' : '')+ const inner = sortable ? (+ <SortButton toggleSort={toggleSort} sortDirection={sortDirection}>+ {labelText}+ </SortButton>+ ) : (+ labelText+ )+ if (warning) {+ return (+ <Tooltip+ info={+ <span className="text-xs font-normal whitespace-nowrap">+ {'* ' + warning}+ </span>+ }+ className="inline-block"+ >+ {inner}+ </Tooltip>+ )+ } else {+ return <>{inner}</>+ }+}++function DimensionCell({+ row,+ getFilterInfo,+ getExternalLinkUrl,+ isActive+}: {+ row: QueryResultRow+ getFilterInfo: (row: QueryResultRow) => FilterInfo | null+ getExternalLinkUrl?: (row: QueryResultRow) => string | null+ isActive?: boolean+}) {+ return (+ <div className="break-all flex items-center gap-x-1">+ <DrilldownLink path={rootRoute.path} filterInfo={getFilterInfo(row)}>+ {row.dimensions[0]}+ </DrilldownLink>+ {typeof getExternalLinkUrl === 'function' && (+ <ExternalLink href={getExternalLinkUrl(row)} isActive={isActive} />+ )}+ </div>+ )+}++function ExternalLink({+ href,+ isActive+}: {+ href: string | null+ isActive?: boolean+}) {+ return (+ <div className="w-4 min-w-4 self-stretch flex flex-col justify-center">+ {href && (+ <a+ target="_blank"+ rel="noreferrer"+ href={href}+ className={isActive ? 'block' : 'hidden'}+ >+ <ExternalLinkIcon />+ </a>+ )}+ </div>+ )+}diff --git a/assets/js/dashboard/stats/modals/devices/browser-versions-modal.js b/assets/js/dashboard/stats/modals/devices/browser-versions-modal.jsindex 460a04aaca..2197ca03be 100644--- a/assets/js/dashboard/stats/modals/devices/browser-versions-modal.js+++ b/assets/js/dashboard/stats/modals/devices/browser-versions-modal.js@@ -1,13 +1,13 @@import React, { useCallback } from 'react'import Modal from './../modal'import { addFilter } from '../../../dashboard-state'-import BreakdownModal from './../breakdown-modal'+import BreakdownModal from '../breakdown-modal-legacy'import * as url from '../../../util/url'import { useDashboardStateContext } from '../../../dashboard-state-context'import { useSiteContext } from '../../../site-context'import { browserIconFor } from '../../devices'import chooseMetrics from './choose-metrics'-import { SortDirection } from '../../../hooks/use-order-by'+import { SortDirection } from '../../../hooks/use-order-by-legacy'function BrowserVersionsModal() {const { dashboardState } = useDashboardStateContext()diff --git a/assets/js/dashboard/stats/modals/devices/browsers-modal.js b/assets/js/dashboard/stats/modals/devices/browsers-modal.jsindex 7cbc87d7dc..f6a14ce1bb 100644--- a/assets/js/dashboard/stats/modals/devices/browsers-modal.js+++ b/assets/js/dashboard/stats/modals/devices/browsers-modal.js@@ -1,13 +1,13 @@import React, { useCallback } from 'react'import Modal from './../modal'import { addFilter } from '../../../dashboard-state'-import BreakdownModal from './../breakdown-modal'+import BreakdownModal from '../breakdown-modal-legacy'import * as url from '../../../util/url'import { useDashboardStateContext } from '../../../dashboard-state-context'import { useSiteContext } from '../../../site-context'import { browserIconFor } from '../../devices'import chooseMetrics from './choose-metrics'-import { SortDirection } from '../../../hooks/use-order-by'+import { SortDirection } from '../../../hooks/use-order-by-legacy'function BrowsersModal() {const { dashboardState } = useDashboardStateContext()diff --git a/assets/js/dashboard/stats/modals/devices/operating-system-versions-modal.js b/assets/js/dashboard/stats/modals/devices/operating-system-versions-modal.jsindex ca3ae19193..50b20d4567 100644--- a/assets/js/dashboard/stats/modals/devices/operating-system-versions-modal.js+++ b/assets/js/dashboard/stats/modals/devices/operating-system-versions-modal.js@@ -1,13 +1,13 @@import React, { useCallback } from 'react'import Modal from './../modal'import { addFilter } from '../../../dashboard-state'-import BreakdownModal from './../breakdown-modal'+import BreakdownModal from '../breakdown-modal-legacy'import * as url from '../../../util/url'import { useDashboardStateContext } from '../../../dashboard-state-context'import { useSiteContext } from '../../../site-context'import { osIconFor } from '../../devices'import chooseMetrics from './choose-metrics'-import { SortDirection } from '../../../hooks/use-order-by'+import { SortDirection } from '../../../hooks/use-order-by-legacy'function OperatingSystemVersionsModal() {const { dashboardState } = useDashboardStateContext()diff --git a/assets/js/dashboard/stats/modals/devices/operating-systems-modal.js b/assets/js/dashboard/stats/modals/devices/operating-systems-modal.jsindex d5f36b2f81..8685c2158a 100644--- a/assets/js/dashboard/stats/modals/devices/operating-systems-modal.js+++ b/assets/js/dashboard/stats/modals/devices/operating-systems-modal.js@@ -1,13 +1,13 @@import React, { useCallback } from 'react'import Modal from './../modal'import { addFilter } from '../../../dashboard-state'-import BreakdownModal from './../breakdown-modal'+import BreakdownModal from '../breakdown-modal-legacy'import * as url from '../../../util/url'import { useDashboardStateContext } from '../../../dashboard-state-context'import { useSiteContext } from '../../../site-context'import { osIconFor } from '../../devices'import chooseMetrics from './choose-metrics'-import { SortDirection } from '../../../hooks/use-order-by'+import { SortDirection } from '../../../hooks/use-order-by-legacy'function OperatingSystemsModal() {const { dashboardState } = useDashboardStateContext()diff --git a/assets/js/dashboard/stats/modals/devices/screen-sizes.js b/assets/js/dashboard/stats/modals/devices/screen-sizes.jsindex 79c3f5da6d..15828f1fc0 100644--- a/assets/js/dashboard/stats/modals/devices/screen-sizes.js+++ b/assets/js/dashboard/stats/modals/devices/screen-sizes.js@@ -1,12 +1,12 @@import React, { useCallback } from 'react'import Modal from './../modal'-import BreakdownModal from './../breakdown-modal'+import BreakdownModal from '../breakdown-modal-legacy'import * as url from '../../../util/url'import { useDashboardStateContext } from '../../../dashboard-state-context'import { useSiteContext } from '../../../site-context'import { screenSizeIconFor } from '../../devices'import chooseMetrics from './choose-metrics'-import { SortDirection } from '../../../hooks/use-order-by'+import { SortDirection } from '../../../hooks/use-order-by-legacy'function ScreenSizesModal() {const { dashboardState } = useDashboardStateContext()diff --git a/assets/js/dashboard/stats/modals/entry-pages.js b/assets/js/dashboard/stats/modals/entry-pages.jsdeleted file mode 100644index a443248ca9..0000000000--- a/assets/js/dashboard/stats/modals/entry-pages.js+++ /dev/null@@ -1,102 +0,0 @@-import React, { useCallback } from 'react'-import Modal from './modal'-import {- hasConversionGoalFilter,- isRealTimeDashboard-} from '../../util/filters'-import { addFilter, revenueAvailable } from '../../dashboard-state'-import BreakdownModal from './breakdown-modal'-import * as metrics from '../reports/metrics'-import * as url from '../../util/url'-import { useDashboardStateContext } from '../../dashboard-state-context'-import { useSiteContext } from '../../site-context'-import { SortDirection } from '../../hooks/use-order-by'--function EntryPagesModal() {- const { dashboardState } = useDashboardStateContext()- const site = useSiteContext()-- /*global BUILD_EXTRA*/- const showRevenueMetrics =- BUILD_EXTRA && revenueAvailable(dashboardState, site)-- const reportInfo = {- title: 'Entry pages',- dimension: 'entry_page',- endpoint: url.apiPath(site, '/entry-pages'),- dimensionLabel: 'Entry page',- defaultOrder: ['visitors', SortDirection.desc]- }-- const getFilterInfo = useCallback(- (listItem) => {- return {- prefix: reportInfo.dimension,- filter: ['is', reportInfo.dimension, [listItem.name]]- }- },- [reportInfo.dimension]- )-- const addSearchFilter = useCallback(- (dashboardState, searchString) => {- return addFilter(dashboardState, [- 'contains',- reportInfo.dimension,- [searchString],- { case_sensitive: false }- ])- },- [reportInfo.dimension]- )-- function chooseMetrics() {- if (hasConversionGoalFilter(dashboardState)) {- return [- metrics.createTotalVisitors(),- metrics.createVisitors({- renderLabel: (_dashboardState) => 'Conversions',- width: 'w-28'- }),- metrics.createConversionRate(),- showRevenueMetrics && metrics.createTotalRevenue(),- showRevenueMetrics && metrics.createAverageRevenue()- ].filter((metric) => !!metric)- }-- if (- isRealTimeDashboard(dashboardState) &&- !hasConversionGoalFilter(dashboardState)- ) {- return [- metrics.createVisitors({- renderLabel: (_dashboardState) => 'Current visitors',- width: 'w-32'- })- ]- }-- return [- metrics.createVisitors({ renderLabel: (_dashboardState) => 'Visitors' }),- metrics.createVisits({- renderLabel: (_dashboardState) => 'Total entrances',- width: 'w-32'- }),- metrics.createBounceRate(),- metrics.createVisitDuration()- ]- }-- return (- <Modal>- <BreakdownModal- reportInfo={reportInfo}- metrics={chooseMetrics()}- getFilterInfo={getFilterInfo}- addSearchFilter={addSearchFilter}- />- </Modal>- )-}--export default EntryPagesModaldiff --git a/assets/js/dashboard/stats/modals/exit-pages.js b/assets/js/dashboard/stats/modals/exit-pages.jsdeleted file mode 100644index 84a5b6f59b..0000000000--- a/assets/js/dashboard/stats/modals/exit-pages.js+++ /dev/null@@ -1,105 +0,0 @@-import React, { useCallback } from 'react'-import Modal from './modal'-import {- hasConversionGoalFilter,- isRealTimeDashboard-} from '../../util/filters'-import { addFilter, revenueAvailable } from '../../dashboard-state'-import BreakdownModal from './breakdown-modal'-import * as metrics from '../reports/metrics'-import * as url from '../../util/url'-import { useDashboardStateContext } from '../../dashboard-state-context'-import { useSiteContext } from '../../site-context'-import { SortDirection } from '../../hooks/use-order-by'--function ExitPagesModal() {- const { dashboardState } = useDashboardStateContext()- const site = useSiteContext()-- /*global BUILD_EXTRA*/- const showRevenueMetrics =- BUILD_EXTRA && revenueAvailable(dashboardState, site)-- const reportInfo = {- title: 'Exit pages',- dimension: 'exit_page',- endpoint: url.apiPath(site, '/exit-pages'),- dimensionLabel: 'Page url',- defaultOrder: ['visitors', SortDirection.desc]- }-- const getFilterInfo = useCallback(- (listItem) => {- return {- prefix: reportInfo.dimension,- filter: ['is', reportInfo.dimension, [listItem.name]]- }- },- [reportInfo.dimension]- )-- const addSearchFilter = useCallback(- (dashboardState, searchString) => {- return addFilter(dashboardState, [- 'contains',- reportInfo.dimension,- [searchString],- { case_sensitive: false }- ])- },- [reportInfo.dimension]- )-- function chooseMetrics() {- if (hasConversionGoalFilter(dashboardState)) {- return [- metrics.createTotalVisitors(),- metrics.createVisitors({- renderLabel: (_dashboardState) => 'Conversions',- width: 'w-28'- }),- metrics.createConversionRate(),- showRevenueMetrics && metrics.createTotalRevenue(),- showRevenueMetrics && metrics.createAverageRevenue()- ].filter((metric) => !!metric)- }-- if (- isRealTimeDashboard(dashboardState) &&- !hasConversionGoalFilter(dashboardState)- ) {- return [- metrics.createVisitors({- renderLabel: (_dashboardState) => 'Current visitors',- width: 'w-32'- })- ]- }-- return [- metrics.createVisitors({- renderLabel: (_dashboardState) => 'Visitors',- sortable: true- }),- metrics.createVisits({- renderLabel: (_dashboardState) => 'Total exits',- width: 'w-32',- sortable: true- }),- metrics.createExitRate()- ]- }-- return (- <Modal>- <BreakdownModal- reportInfo={reportInfo}- metrics={chooseMetrics()}- getFilterInfo={getFilterInfo}- addSearchFilter={addSearchFilter}- />- </Modal>- )-}--export default ExitPagesModaldiff --git a/assets/js/dashboard/stats/modals/google-keywords.tsx b/assets/js/dashboard/stats/modals/google-keywords.tsxindex cf8ce484de..256d172eb3 100644--- a/assets/js/dashboard/stats/modals/google-keywords.tsx+++ b/assets/js/dashboard/stats/modals/google-keywords.tsx@@ -11,8 +11,8 @@ import {} from '../../util/number-formatter'import { apiPath } from '../../util/url'import { DashboardState } from '../../dashboard-state'-import { ColumnConfiguraton } from '../../components/table'-import { BreakdownTable } from './breakdown-table'+import { ColumnConfiguraton } from '../../components/table-legacy'+import { BreakdownTable } from './breakdown-table-legacy'type GoogleKeywordItem = {visitors: stringdiff --git a/assets/js/dashboard/stats/modals/locations-modal.js b/assets/js/dashboard/stats/modals/locations-modal.jsindex ec3a5c5548..fbfdd97c92 100644--- a/assets/js/dashboard/stats/modals/locations-modal.js+++ b/assets/js/dashboard/stats/modals/locations-modal.js@@ -5,13 +5,13 @@ import {hasConversionGoalFilter,isRealTimeDashboard} from '../../util/filters'-import BreakdownModal from './breakdown-modal'+import BreakdownModal from './breakdown-modal-legacy'import * as metrics from '../reports/metrics'import * as url from '../../util/url'import { useDashboardStateContext } from '../../dashboard-state-context'import { useSiteContext } from '../../site-context'import { addFilter, revenueAvailable } from '../../dashboard-state'-import { SortDirection } from '../../hooks/use-order-by'+import { SortDirection } from '../../hooks/use-order-by-legacy'const VIEWS = {countries: {diff --git a/assets/js/dashboard/stats/modals/pages.js b/assets/js/dashboard/stats/modals/pages.jsdeleted file mode 100644index b93ab5869e..0000000000--- a/assets/js/dashboard/stats/modals/pages.js+++ /dev/null@@ -1,100 +0,0 @@-import React, { useCallback } from 'react'-import Modal from './modal'-import {- hasConversionGoalFilter,- isRealTimeDashboard-} from '../../util/filters'-import { addFilter, revenueAvailable } from '../../dashboard-state'-import BreakdownModal from './breakdown-modal'-import * as metrics from '../reports/metrics'-import * as url from '../../util/url'-import { useDashboardStateContext } from '../../dashboard-state-context'-import { useSiteContext } from '../../site-context'-import { SortDirection } from '../../hooks/use-order-by'--function PagesModal() {- const { dashboardState } = useDashboardStateContext()- const site = useSiteContext()-- /*global BUILD_EXTRA*/- const showRevenueMetrics =- BUILD_EXTRA && revenueAvailable(dashboardState, site)-- const reportInfo = {- title: 'Top pages',- dimension: 'page',- endpoint: url.apiPath(site, '/pages'),- dimensionLabel: 'Page url',- defaultOrder: ['visitors', SortDirection.desc]- }-- const getFilterInfo = useCallback(- (listItem) => {- return {- prefix: reportInfo.dimension,- filter: ['is', reportInfo.dimension, [listItem.name]]- }- },- [reportInfo.dimension]- )-- const addSearchFilter = useCallback(- (dashboardState, searchString) => {- return addFilter(dashboardState, [- 'contains',- reportInfo.dimension,- [searchString],- { case_sensitive: false }- ])- },- [reportInfo.dimension]- )-- function chooseMetrics() {- if (hasConversionGoalFilter(dashboardState)) {- return [- metrics.createTotalVisitors(),- metrics.createVisitors({- renderLabel: (_dashboardState) => 'Conversions',- width: 'w-28'- }),- metrics.createConversionRate(),- showRevenueMetrics && metrics.createTotalRevenue(),- showRevenueMetrics && metrics.createAverageRevenue()- ].filter((metric) => !!metric)- }-- if (- isRealTimeDashboard(dashboardState) &&- !hasConversionGoalFilter(dashboardState)- ) {- return [- metrics.createVisitors({- renderLabel: (_dashboardState) => 'Current visitors',- width: 'w-32'- })- ]- }-- return [- metrics.createVisitors({ renderLabel: (_dashboardState) => 'Visitors' }),- metrics.createPageviews(),- metrics.createBounceRate(),- metrics.createTimeOnPage(),- metrics.createScrollDepth()- ]- }-- return (- <Modal>- <BreakdownModal- reportInfo={reportInfo}- metrics={chooseMetrics()}- getFilterInfo={getFilterInfo}- addSearchFilter={addSearchFilter}- />- </Modal>- )-}--export default PagesModaldiff --git a/assets/js/dashboard/stats/modals/props.js b/assets/js/dashboard/stats/modals/props.jsindex 8dcc8e6e0b..eae9c6344c 100644--- a/assets/js/dashboard/stats/modals/props.js+++ b/assets/js/dashboard/stats/modals/props.js@@ -9,12 +9,12 @@ import {getGoalFilter,hasConversionGoalFilter} from '../../util/filters'-import BreakdownModal from './breakdown-modal'+import BreakdownModal from './breakdown-modal-legacy'import * as metrics from '../reports/metrics'import * as url from '../../util/url'import { useDashboardStateContext } from '../../dashboard-state-context'import { useSiteContext } from '../../site-context'-import { SortDirection } from '../../hooks/use-order-by'+import { SortDirection } from '../../hooks/use-order-by-legacy'function PropsModal() {const { dashboardState } = useDashboardStateContext()diff --git a/assets/js/dashboard/stats/modals/referrer-drilldown.js b/assets/js/dashboard/stats/modals/referrer-drilldown.jsindex 8266a6fc54..6ee599a4ac 100644--- a/assets/js/dashboard/stats/modals/referrer-drilldown.js+++ b/assets/js/dashboard/stats/modals/referrer-drilldown.js@@ -6,13 +6,13 @@ import {hasConversionGoalFilter,isRealTimeDashboard} from '../../util/filters'-import BreakdownModal from './breakdown-modal'+import BreakdownModal from './breakdown-modal-legacy'import * as metrics from '../reports/metrics'import * as url from '../../util/url'import { addFilter, revenueAvailable } from '../../dashboard-state'import { useDashboardStateContext } from '../../dashboard-state-context'import { useSiteContext } from '../../site-context'-import { SortDirection } from '../../hooks/use-order-by'+import { SortDirection } from '../../hooks/use-order-by-legacy'import { SourceFavicon } from '../sources/source-favicon'function ReferrerDrilldownModal() {diff --git a/assets/js/dashboard/stats/modals/sources.js b/assets/js/dashboard/stats/modals/sources.jsindex b52b8e20e2..7d06fb8cde 100644--- a/assets/js/dashboard/stats/modals/sources.js+++ b/assets/js/dashboard/stats/modals/sources.js@@ -4,13 +4,13 @@ import {hasConversionGoalFilter,isRealTimeDashboard} from '../../util/filters'-import BreakdownModal from './breakdown-modal'+import BreakdownModal from './breakdown-modal-legacy'import * as metrics from '../reports/metrics'import * as url from '../../util/url'import { addFilter, revenueAvailable } from '../../dashboard-state'import { useDashboardStateContext } from '../../dashboard-state-context'import { useSiteContext } from '../../site-context'-import { SortDirection } from '../../hooks/use-order-by'+import { SortDirection } from '../../hooks/use-order-by-legacy'import { SourceFavicon } from '../sources/source-favicon'const VIEWS = {diff --git a/assets/js/dashboard/stats/pages/entry-pages.tsx b/assets/js/dashboard/stats/pages/entry-pages.tsxnew file mode 100644index 0000000000..35fa971944--- /dev/null+++ b/assets/js/dashboard/stats/pages/entry-pages.tsx@@ -0,0 +1,106 @@+import React, { useCallback } from 'react'+import Modal from '../modals/modal'+import { Metric } from '../metrics'+import * as url from '../../util/url'+import { StatsQuery } from '../../stats-query'+import { IndexBreakdown } from '../reports/index-breakdown'+import { DetailsBreakdown } from '../modals/details-breakdown'+import { useDashboardStateContext } from '../../dashboard-state-context'+import { useSiteContext } from '../../site-context'+import {+ hasConversionGoalFilter,+ isRealTimeDashboard+} from '../../util/filters'+import { revenueAvailable, Filter } from '../../dashboard-state'+import { QueryApiResponse, QueryResultRow } from '../../api'+import { SortDirection } from '../../hooks/use-order-by'+import { addDimensionSearchFilter, getBreakdownMetrics } from '../breakdowns'+import { PAGES_BAR_COLOR } from './pages'++const DIMENSION = 'visit:entry_page'+const DETAILED_METRICS: Metric[] = [+ 'visitors',+ 'percentage',+ 'visits',+ 'bounce_rate',+ 'visit_duration'+]++function getFilterInfo(row: QueryResultRow) {+ return {+ prefix: 'entry_page',+ filter: ['is', 'entry_page', [row.dimensions[0]]] as Filter+ }+}++function addSearchFilter(statsQuery: StatsQuery, search: string) {+ return addDimensionSearchFilter(statsQuery, DIMENSION, search)+}++export function EntryPagesIndex({+ onDataReady+}: {+ onDataReady?: (data: QueryApiResponse) => void+}) {+ const { dashboardState } = useDashboardStateContext()+ const site = useSiteContext()++ const metrics = getBreakdownMetrics({+ hasConversionGoalFilter: hasConversionGoalFilter(dashboardState),+ isRealtime: isRealTimeDashboard(dashboardState)+ })++ const getExternalLinkUrl = useCallback(+ (row: QueryResultRow) => url.externalLinkForPage(site, row.dimensions[0]),+ [site]+ )++ return (+ <IndexBreakdown+ metrics={metrics}+ dimensions={[DIMENSION]}+ color={PAGES_BAR_COLOR}+ getExternalLinkUrl={getExternalLinkUrl}+ getFilterInfo={getFilterInfo}+ dimensionLabel="Entry page"+ onDataReady={onDataReady}+ />+ )+}++export function EntryPagesDetails() {+ const { dashboardState } = useDashboardStateContext()+ const site = useSiteContext()++ /*global BUILD_EXTRA*/+ const isRevenueAvailable =+ BUILD_EXTRA && revenueAvailable(dashboardState, site)++ const metrics = getBreakdownMetrics({+ hasConversionGoalFilter: hasConversionGoalFilter(dashboardState),+ isRealtime: isRealTimeDashboard(dashboardState),+ isDetailed: true,+ isRevenueAvailable: isRevenueAvailable,+ detailedMetrics: DETAILED_METRICS+ })++ const getExternalLinkUrl = useCallback(+ (row: QueryResultRow) => url.externalLinkForPage(site, row.dimensions[0]),+ [site]+ )++ return (+ <Modal>+ <DetailsBreakdown+ title="Entry pages"+ dimensionLabel="Entry page"+ dimensions={[DIMENSION]}+ metrics={metrics}+ defaultOrderBy={[['visitors', SortDirection.desc]]}+ getFilterInfo={getFilterInfo}+ getExternalLinkUrl={getExternalLinkUrl}+ addSearchFilter={addSearchFilter}+ />+ </Modal>+ )+}diff --git a/assets/js/dashboard/stats/pages/exit-pages.tsx b/assets/js/dashboard/stats/pages/exit-pages.tsxnew file mode 100644index 0000000000..71625afbac--- /dev/null+++ b/assets/js/dashboard/stats/pages/exit-pages.tsx@@ -0,0 +1,105 @@+import React, { useCallback } from 'react'+import Modal from '../modals/modal'+import { Metric } from '../metrics'+import * as url from '../../util/url'+import { StatsQuery } from '../../stats-query'+import { IndexBreakdown } from '../reports/index-breakdown'+import { DetailsBreakdown } from '../modals/details-breakdown'+import { useDashboardStateContext } from '../../dashboard-state-context'+import { useSiteContext } from '../../site-context'+import {+ hasConversionGoalFilter,+ isRealTimeDashboard+} from '../../util/filters'+import { revenueAvailable, Filter } from '../../dashboard-state'+import { QueryApiResponse, QueryResultRow } from '../../api'+import { SortDirection } from '../../hooks/use-order-by'+import { addDimensionSearchFilter, getBreakdownMetrics } from '../breakdowns'+import { PAGES_BAR_COLOR } from './pages'++const DIMENSION = 'visit:exit_page'+const DETAILED_METRICS: Metric[] = [+ 'visitors',+ 'percentage',+ 'visits',+ 'exit_rate'+]++function getFilterInfo(row: QueryResultRow) {+ return {+ prefix: 'exit_page',+ filter: ['is', 'exit_page', [row.dimensions[0]]] as Filter+ }+}++function addSearchFilter(statsQuery: StatsQuery, search: string) {+ return addDimensionSearchFilter(statsQuery, DIMENSION, search)+}++export function ExitPagesIndex({+ onDataReady+}: {+ onDataReady?: (data: QueryApiResponse) => void+}) {+ const { dashboardState } = useDashboardStateContext()+ const site = useSiteContext()++ const metrics = getBreakdownMetrics({+ hasConversionGoalFilter: hasConversionGoalFilter(dashboardState),+ isRealtime: isRealTimeDashboard(dashboardState)+ })++ const getExternalLinkUrl = useCallback(+ (row: QueryResultRow) => url.externalLinkForPage(site, row.dimensions[0]),+ [site]+ )++ return (+ <IndexBreakdown+ metrics={metrics}+ dimensions={[DIMENSION]}+ color={PAGES_BAR_COLOR}+ getExternalLinkUrl={getExternalLinkUrl}+ getFilterInfo={getFilterInfo}+ dimensionLabel="Exit page"+ onDataReady={onDataReady}+ />+ )+}++export function ExitPagesDetails() {+ const { dashboardState } = useDashboardStateContext()+ const site = useSiteContext()++ /*global BUILD_EXTRA*/+ const isRevenueAvailable =+ BUILD_EXTRA && revenueAvailable(dashboardState, site)++ const metrics = getBreakdownMetrics({+ hasConversionGoalFilter: hasConversionGoalFilter(dashboardState),+ isRealtime: isRealTimeDashboard(dashboardState),+ isDetailed: true,+ isRevenueAvailable: isRevenueAvailable,+ detailedMetrics: [...DETAILED_METRICS]+ })++ const getExternalLinkUrl = useCallback(+ (row: QueryResultRow) => url.externalLinkForPage(site, row.dimensions[0]),+ [site]+ )++ return (+ <Modal>+ <DetailsBreakdown+ title="Exit pages"+ dimensionLabel="Exit page"+ dimensions={[DIMENSION]}+ metrics={metrics}+ defaultOrderBy={[['visitors', SortDirection.desc]]}+ getFilterInfo={getFilterInfo}+ getExternalLinkUrl={getExternalLinkUrl}+ addSearchFilter={addSearchFilter}+ />+ </Modal>+ )+}diff --git a/assets/js/dashboard/stats/pages/index.js b/assets/js/dashboard/stats/pages/index.jsindex 962cb935a5..75d2d07354 100644--- a/assets/js/dashboard/stats/pages/index.js+++ b/assets/js/dashboard/stats/pages/index.js@@ -1,10 +1,6 @@import React, { useEffect, useState } from 'react'import * as storage from '../../util/storage'-import * as url from '../../util/url'-import * as api from '../../api'-import ListReport from './../reports/list'-import * as metrics from './../reports/metrics'import ImportedQueryUnsupportedWarning from '../imported-query-unsupported-warning'import { hasConversionGoalFilter } from '../../util/filters'import { useDashboardStateContext } from '../../dashboard-state-context'@@ -15,138 +11,9 @@ import { ReportHeader } from '../reports/report-header'import { TabButton, TabWrapper } from '../../components/tabs'import MoreLink from '../more-link'import { MoreLinkState } from '../more-link-state'--function EntryPages({ afterFetchData }) {- const { dashboardState } = useDashboardStateContext()- const site = useSiteContext()- function fetchData() {- return api.get(url.apiPath(site, '/entry-pages'), dashboardState, {- limit: 9- })- }-- function getExternalLinkUrl(page) {- return url.externalLinkForPage(site, page.name)- }-- function getFilterInfo(listItem) {- return {- prefix: 'entry_page',- filter: ['is', 'entry_page', [listItem['name']]]- }- }-- function chooseMetrics() {- return [- metrics.createVisitors({- defaultLabel: 'Unique entrances',- width: 'w-36',- meta: { plot: true }- }),- !hasConversionGoalFilter(dashboardState) &&- metrics.createPercentage({ meta: { showOnHover: true } }),- hasConversionGoalFilter(dashboardState) && metrics.createConversionRate()- ].filter((metric) => !!metric)- }-- return (- <ListReport- fetchData={fetchData}- afterFetchData={afterFetchData}- getFilterInfo={getFilterInfo}- keyLabel="Entry page"- metrics={chooseMetrics()}- getExternalLinkUrl={getExternalLinkUrl}- color="bg-orange-50 group-hover/row:bg-orange-100"- />- )-}--function ExitPages({ afterFetchData }) {- const site = useSiteContext()- const { dashboardState } = useDashboardStateContext()- function fetchData() {- return api.get(url.apiPath(site, '/exit-pages'), dashboardState, {- limit: 9- })- }-- function getExternalLinkUrl(page) {- return url.externalLinkForPage(site, page.name)- }-- function getFilterInfo(listItem) {- return {- prefix: 'exit_page',- filter: ['is', 'exit_page', [listItem['name']]]- }- }-- function chooseMetrics() {- return [- metrics.createVisitors({- defaultLabel: 'Unique exits',- width: 'w-36',- meta: { plot: true }- }),- !hasConversionGoalFilter(dashboardState) &&- metrics.createPercentage({ meta: { showOnHover: true } }),- hasConversionGoalFilter(dashboardState) && metrics.createConversionRate()- ].filter((metric) => !!metric)- }-- return (- <ListReport- fetchData={fetchData}- afterFetchData={afterFetchData}- getFilterInfo={getFilterInfo}- keyLabel="Exit page"- metrics={chooseMetrics()}- getExternalLinkUrl={getExternalLinkUrl}- color="bg-orange-50 group-hover/row:bg-orange-100"- />- )-}--function TopPages({ afterFetchData }) {- const { dashboardState } = useDashboardStateContext()- const site = useSiteContext()- function fetchData() {- return api.get(url.apiPath(site, '/pages'), dashboardState, { limit: 9 })- }-- function getExternalLinkUrl(page) {- return url.externalLinkForPage(site, page.name)- }-- function getFilterInfo(listItem) {- return {- prefix: 'page',- filter: ['is', 'page', [listItem['name']]]- }- }-- function chooseMetrics() {- return [- metrics.createVisitors({ meta: { plot: true } }),- !hasConversionGoalFilter(dashboardState) &&- metrics.createPercentage({ meta: { showOnHover: true } }),- hasConversionGoalFilter(dashboardState) && metrics.createConversionRate()- ].filter((metric) => !!metric)- }-- return (- <ListReport- fetchData={fetchData}- afterFetchData={afterFetchData}- getFilterInfo={getFilterInfo}- keyLabel="Page"- metrics={chooseMetrics()}- getExternalLinkUrl={getExternalLinkUrl}- color="bg-orange-50 group-hover/row:bg-orange-100"- />- )-}+import { PagesIndex } from './pages'+import { EntryPagesIndex } from './entry-pages'+import { ExitPagesIndex } from './exit-pages'export default function Pages() {const { dashboardState } = useDashboardStateContext()@@ -164,10 +31,10 @@ export default function Pages() {setMode(mode)}- function afterFetchData(apiResponse) {+ function onDataReady(queryApiResponse) {setLoading(false)- setSkipImportedReason(apiResponse.skip_imported_reason)- if (apiResponse.results && apiResponse.results.length > 0) {+ setSkipImportedReason(queryApiResponse.meta?.imports_skip_reason)+ if (queryApiResponse.results && queryApiResponse.results.length > 0) {setMoreLinkState(MoreLinkState.READY)} else {setMoreLinkState(MoreLinkState.HIDDEN)@@ -203,12 +70,12 @@ export default function Pages() {function renderContent() {switch (mode) {case 'entry-pages':- return <EntryPages afterFetchData={afterFetchData} />+ return <EntryPagesIndex onDataReady={onDataReady} />case 'exit-pages':- return <ExitPages afterFetchData={afterFetchData} />+ return <ExitPagesIndex onDataReady={onDataReady} />case 'pages':default:- return <TopPages afterFetchData={afterFetchData} />+ return <PagesIndex onDataReady={onDataReady} />}}diff --git a/assets/js/dashboard/stats/pages/pages.tsx b/assets/js/dashboard/stats/pages/pages.tsxnew file mode 100644index 0000000000..6eefc47943--- /dev/null+++ b/assets/js/dashboard/stats/pages/pages.tsx@@ -0,0 +1,108 @@+import React, { useCallback } from 'react'+import Modal from '../modals/modal'+import { Metric } from '../metrics'+import * as url from '../../util/url'+import { StatsQuery } from '../../stats-query'+import { IndexBreakdown } from '../reports/index-breakdown'+import { DetailsBreakdown } from '../modals/details-breakdown'+import { useDashboardStateContext } from '../../dashboard-state-context'+import { useSiteContext } from '../../site-context'+import {+ hasConversionGoalFilter,+ isRealTimeDashboard+} from '../../util/filters'+import { revenueAvailable, Filter } from '../../dashboard-state'+import { QueryApiResponse, QueryResultRow } from '../../api'+import { SortDirection } from '../../hooks/use-order-by'+import { addDimensionSearchFilter, getBreakdownMetrics } from '../breakdowns'++export const PAGES_BAR_COLOR = 'bg-orange-50 group-hover/row:bg-orange-100'++const DIMENSION = 'event:page'+const DETAILED_METRICS: Metric[] = [+ 'visitors',+ 'percentage',+ 'pageviews',+ 'bounce_rate',+ 'time_on_page',+ 'scroll_depth'+]++function getFilterInfo(row: QueryResultRow) {+ return {+ prefix: 'page',+ filter: ['is', 'page', [row.dimensions[0]]] as Filter+ }+}++function addSearchFilter(statsQuery: StatsQuery, search: string) {+ return addDimensionSearchFilter(statsQuery, DIMENSION, search)+}++export function PagesIndex({+ onDataReady+}: {+ onDataReady?: (data: QueryApiResponse) => void+}) {+ const { dashboardState } = useDashboardStateContext()+ const site = useSiteContext()++ const metrics = getBreakdownMetrics({+ hasConversionGoalFilter: hasConversionGoalFilter(dashboardState),+ isRealtime: isRealTimeDashboard(dashboardState)+ })++ const getExternalLinkUrl = useCallback(+ (row: QueryResultRow) => url.externalLinkForPage(site, row.dimensions[0]),+ [site]+ )++ return (+ <IndexBreakdown+ metrics={metrics}+ dimensions={[DIMENSION]}+ color={PAGES_BAR_COLOR}+ getExternalLinkUrl={getExternalLinkUrl}+ getFilterInfo={getFilterInfo}+ dimensionLabel="Page"+ onDataReady={onDataReady}+ />+ )+}++export function PagesDetails() {+ const { dashboardState } = useDashboardStateContext()+ const site = useSiteContext()++ /*global BUILD_EXTRA*/+ const isRevenueAvailable =+ BUILD_EXTRA && revenueAvailable(dashboardState, site)++ const metrics = getBreakdownMetrics({+ hasConversionGoalFilter: hasConversionGoalFilter(dashboardState),+ isRealtime: isRealTimeDashboard(dashboardState),+ isDetailed: true,+ isRevenueAvailable: isRevenueAvailable,+ detailedMetrics: DETAILED_METRICS+ })++ const getExternalLinkUrl = useCallback(+ (row: QueryResultRow) => url.externalLinkForPage(site, row.dimensions[0]),+ [site]+ )++ return (+ <Modal>+ <DetailsBreakdown+ title="Top pages"+ dimensionLabel="Page url"+ dimensions={[DIMENSION]}+ metrics={metrics}+ defaultOrderBy={[['visitors', SortDirection.desc]]}+ getFilterInfo={getFilterInfo}+ getExternalLinkUrl={getExternalLinkUrl}+ addSearchFilter={addSearchFilter}+ />+ </Modal>+ )+}diff --git a/assets/js/dashboard/stats/reports/change-arrow.tsx b/assets/js/dashboard/stats/reports/change-arrow.tsxindex d6b8c4ccde..c227a24e29 100644--- a/assets/js/dashboard/stats/reports/change-arrow.tsx+++ b/assets/js/dashboard/stats/reports/change-arrow.tsx@@ -1,5 +1,5 @@import React from 'react'-import { Metric } from '../../../types/query-api'+import { Metric } from '../metrics'import { numberShortFormatter } from '../../util/number-formatter'import { ArrowDownRightIcon, ArrowUpRightIcon } from '@heroicons/react/24/solid'import classNames from 'classnames'diff --git a/assets/js/dashboard/stats/reports/index-breakdown.tsx b/assets/js/dashboard/stats/reports/index-breakdown.tsxnew file mode 100644index 0000000000..425d77ba37--- /dev/null+++ b/assets/js/dashboard/stats/reports/index-breakdown.tsx@@ -0,0 +1,607 @@+import React, { useCallback, useMemo, useState, useEffect } from 'react'+import FlipMove from 'react-flip-move'+import LazyLoader from '../../components/lazy-loader'+import { trimURL } from '../../util/url'+import { useDashboardStateContext } from '../../dashboard-state-context'+import { useSiteContext } from '../../site-context'+import { getStaleTime } from '../../hooks/api-client'+import { createStatsQuery } from '../../stats-query'+import type { StatsQuery } from '../../stats-query'+import { Metric, getBreakdownMetricLabel } from '../metrics'+import {+ ColumnConfiguration,+ ExternalLinkIcon,+ MetricValueTooltipContent,+ SharedBreakdownReportProps,+ formatDateRangeLabel,+ useBodyPortalRef,+ extractMetricValue+} from '../breakdowns'+import { DrilldownLink, FilterInfo } from '../../components/drilldown-link'+import {+ QueryResultRow,+ QueryResultQuery,+ QueryApiResponse,+ stats+} from '../../api'+import classNames from 'classnames'+import { Tooltip } from '../../util/tooltip'+import { ChangeArrow } from './change-arrow'+import { MetricFormatterShort, MetricFormatterLong } from './metric-formatter'+import {+ hasConversionGoalFilter,+ isRealTimeDashboard+} from '../../util/filters'+import { useQuery, useQueryClient } from '@tanstack/react-query'+import { DashboardPeriod } from '../../dashboard-time-periods'+import { DashboardState } from '../../dashboard-state'+import { SortDirection } from '../../hooks/use-order-by-legacy'+import { OrderBy } from '../../hooks/use-order-by'++const MAX_ITEMS = 9+export const MIN_HEIGHT = 356+const ROW_HEIGHT = 32+const ROW_GAP_HEIGHT = 4+const DATA_CONTAINER_HEIGHT =+ (ROW_HEIGHT + ROW_GAP_HEIGHT) * (MAX_ITEMS - 1) + ROW_HEIGHT++const MAX_DIMENSION_LENGTH = 70++const DEFAULT_METRIC_COLUMN_WIDTH = 'w-16 min-w-16'+const VISITORS_WITH_PERCENTAGE_COLUMN_WIDTH = 'w-32 min-w-32'++const BAR_METRIC = 'visitors'++type IndexBreakdownProps = SharedBreakdownReportProps & {+ color: string+ metricColumnWidth?: string+ onDataReady?: (data: QueryApiResponse) => void+}++export function IndexBreakdown({+ metrics,+ dimensions,+ color,+ getFilterInfo,+ getExternalLinkUrl,+ dimensionLabel,+ onDataReady,+ metricColumnWidth = DEFAULT_METRIC_COLUMN_WIDTH+}: IndexBreakdownProps) {+ const site = useSiteContext()+ const { dashboardState } = useDashboardStateContext()+ const [visible, setVisible] = useState(false)+ const isRealtime = dashboardState.period === DashboardPeriod.realtime+ const [isRealtimeSilentUpdate, setIsRealtimeSilentUpdate] = useState(false)+ const queryClient = useQueryClient()++ const statsQuery: StatsQuery = useMemo(() => {+ return createStatsQuery(dashboardState, {+ metrics,+ dimensions,+ order_by: [['visitors', SortDirection.desc]].concat(+ dimensions.map((dim) => [dim, SortDirection.asc])+ ) as OrderBy,+ pagination: { limit: MAX_ITEMS, offset: 0 }+ })+ }, [dashboardState, metrics, dimensions])++ const dimensionKey = statsQuery.dimensions.join(',')++ const apiState = useQuery<QueryApiResponse>({+ queryKey: [dimensionKey, dashboardState],+ enabled: visible,+ queryFn: () => stats(site, statsQuery),+ staleTime: getStaleTime({+ siteTimezoneOffset: site.offset,+ siteStatsBegin: site.statsBegin,+ ...dashboardState+ })+ })++ useEffect(() => {+ if (apiState.data && typeof onDataReady === 'function') {+ onDataReady(apiState.data)+ }+ }, [apiState.data, onDataReady])++ useEffect(() => {+ if (!apiState.isRefetching) {+ setIsRealtimeSilentUpdate(false)+ }+ }, [apiState.isRefetching])++ useEffect(() => {+ if (!isRealtime) {+ setIsRealtimeSilentUpdate(false)+ }+ }, [isRealtime])++ useEffect(() => {+ const onTick = () => {+ setIsRealtimeSilentUpdate(true)+ queryClient.invalidateQueries({+ predicate: ({ queryKey }) =>+ queryKey[0] === dimensionKey &&+ typeof queryKey[1] === 'object' &&+ (queryKey[1] as DashboardState)?.period === DashboardPeriod.realtime+ })+ }++ if (isRealtime) {+ document.addEventListener('tick', onTick)+ }++ return () => {+ document.removeEventListener('tick', onTick)+ }+ }, [queryClient, isRealtime, dimensionKey])++ const query: QueryResultQuery | null = apiState.data?.query ?? null++ const barMetricIndex = query+ ? query.metrics.findIndex((m) => m === BAR_METRIC)+ : null++ const barMaxValue = useMemo(() => {+ const rows = apiState.data?.results ?? []+ return barMetricIndex === null+ ? null+ : Math.max(...rows.map((r) => r.metrics[barMetricIndex] as number))+ }, [apiState.data, barMetricIndex])++ const metricLabelFor = useCallback(+ (metric: Metric): string => {+ return getBreakdownMetricLabel(metric, {+ hasConversionGoalFilter: hasConversionGoalFilter(dashboardState),+ isRealtime: isRealTimeDashboard(dashboardState),+ dimensions: dimensions+ })+ },+ [dashboardState, dimensions]+ )++ const columns = useMemo((): ColumnConfiguration<QueryResultRow>[] | null => {+ if (!query || barMetricIndex === null || barMaxValue === null) return null++ // Only render columns for metrics the API actually returned. Also,+ // percentage is not its own column —- it's shown inline in the+ // visitors cell instead.+ const filteredMetrics = query.metrics.filter((m) => m !== 'percentage')++ const hasPercentage = query.metrics.includes('percentage')+ const isVisitorsWithPercentageCell = (m: Metric) =>+ hasPercentage && m === 'visitors'++ return [+ {+ key: 'dimension',+ renderLabel: () => dimensionLabel,+ renderCell: (row, isActive) => (+ <DimensionCell+ row={row}+ color={color}+ barWidthPercent={+ ((row.metrics[barMetricIndex] as number) / barMaxValue) * 100+ }+ getFilterInfo={getFilterInfo}+ getExternalLinkUrl={getExternalLinkUrl}+ isActive={isActive}+ />+ ),+ align: 'left'+ },+ ...filteredMetrics.map(+ (metric): ColumnConfiguration<QueryResultRow> => ({+ key: metric,+ renderLabel: () => metricLabelFor(metric),+ renderCell: (row, isActive) => {+ if (isVisitorsWithPercentageCell(metric)) {+ return (+ <VisitorsWithPercentageCell+ row={row}+ query={query}+ isActive={isActive}+ />+ )+ } else {+ return (+ <MetricValueCell+ row={row}+ metric={metric}+ metricLabel={metricLabelFor(metric)}+ query={query}+ />+ )+ }+ },+ width: isVisitorsWithPercentageCell(metric)+ ? VISITORS_WITH_PERCENTAGE_COLUMN_WIDTH+ : metricColumnWidth,+ align: 'right'+ })+ )+ ]+ }, [+ dimensionLabel,+ color,+ barMetricIndex,+ metricLabelFor,+ barMaxValue,+ query,+ getFilterInfo,+ getExternalLinkUrl,+ metricColumnWidth+ ])++ return (+ <LazyLoader onVisible={() => setVisible(true)}>+ <IndexBreakdownRenderer+ {...apiState}+ isRealtimeSilentUpdate={isRealtimeSilentUpdate}+ columns={columns}+ />+ </LazyLoader>+ )+}++function DimensionCell({+ row,+ color,+ barWidthPercent,+ getFilterInfo,+ getExternalLinkUrl,+ isActive+}: {+ row: QueryResultRow+ color: string+ barWidthPercent: number+ getFilterInfo: (row: QueryResultRow) => FilterInfo | null+ getExternalLinkUrl?: (row: QueryResultRow) => string | null+ isActive?: boolean+}) {+ const externalUrl = getExternalLinkUrl?.(row)+ return (+ <div className="w-full h-full relative">+ <div+ className={`absolute top-0 left-0 h-full rounded-sm ${color} dark:bg-gray-500/15 dark:group-hover/row:bg-gray-500/30`}+ style={{ width: `${barWidthPercent}%` }}+ />+ <div className="flex justify-start items-center gap-x-1.5 px-2 py-1.5 text-sm dark:text-gray-300 relative z-9 break-all w-full">+ <DrilldownLink+ filterInfo={getFilterInfo(row)}+ extraClass="max-w-max w-full flex items-center md:overflow-hidden"+ >+ <span className="w-full md:truncate">+ {trimURL(row.dimensions[0], MAX_DIMENSION_LENGTH)}+ </span>+ </DrilldownLink>+ {externalUrl && <ExternalLink href={externalUrl} isActive={isActive} />}+ </div>+ </div>+ )+}++function VisitorsWithPercentageCell({+ row,+ query,+ isActive+}: {+ row: QueryResultRow+ query: QueryResultQuery+ isActive?: boolean+}) {+ const portalRef = useBodyPortalRef()++ const { value: visitorsValue, comparison: visitorsComparison } =+ extractMetricValue(row, query, 'visitors')+ const { value: percentageValue, comparison: percentageComparison } =+ extractMetricValue(row, query, 'percentage')++ const visitorsShortFormatter = MetricFormatterShort['visitors']+ const visitorsLongFormatter = MetricFormatterLong['visitors']+ const percentageFormatter = MetricFormatterShort['percentage']++ const isVisitorsAbbreviated =+ visitorsValue !== null &&+ visitorsShortFormatter(visitorsValue) !==+ visitorsLongFormatter(visitorsValue)++ const showVisitorsTooltip = !!visitorsComparison || isVisitorsAbbreviated+ const showPercentageTooltip = !!percentageComparison++ const dateRangeLabel = formatDateRangeLabel(query.date_range)+ const comparisonDateRangeLabel = query.comparison_date_range+ ? formatDateRangeLabel(query.comparison_date_range)+ : null++ const percentageCell = (+ <span+ data-testid="metric-value"+ className={classNames('block w-full text-gray-500 dark:text-gray-400', {+ 'translate-x-0 opacity-100 transition-all duration-150': isActive,+ 'translate-x-[100%] opacity-0 transition-all duration-150 md:group-hover/report:translate-x-0 md:group-hover/report:opacity-100':+ !isActive+ })}+ >+ {percentageFormatter(percentageValue)}+ {percentageComparison && (+ <ChangeArrow+ change={percentageComparison.change}+ metric={'percentage' as Metric}+ className="inline-block pl-1 w-4"+ hideNumber+ />+ )}+ </span>+ )++ const percentageWithTooltip = showPercentageTooltip ? (+ <Tooltip+ containerRef={portalRef as React.RefObject<HTMLElement>}+ info={+ <MetricValueTooltipContent+ value={percentageValue}+ comparison={percentageComparison}+ metric={'percentage'}+ metricLabel="Percentage"+ dateRangeLabel={dateRangeLabel}+ comparisonDateRangeLabel={comparisonDateRangeLabel}+ />+ }+ >+ {percentageCell}+ </Tooltip>+ ) : (+ percentageCell+ )++ const visitorsCell = (+ <span+ className={classNames('block w-full', {+ 'transition-transform duration-150 translate-x-0': isActive,+ 'transition-transform duration-150 translate-x-[100%] md:group-hover/report:translate-x-0':+ !isActive+ })}+ data-testid="metric-value"+ >+ {visitorsShortFormatter(visitorsValue)}+ {visitorsComparison && (+ <ChangeArrow+ change={visitorsComparison.change}+ metric={'visitors'}+ className="inline-block pl-1 w-4"+ hideNumber+ />+ )}+ </span>+ )++ const visitorsWithTooltip = showVisitorsTooltip ? (+ <Tooltip+ containerRef={portalRef as React.RefObject<HTMLElement>}+ info={+ <MetricValueTooltipContent+ value={visitorsValue}+ comparison={visitorsComparison}+ metric={'visitors'}+ metricLabel="Visitors"+ dateRangeLabel={dateRangeLabel}+ comparisonDateRangeLabel={comparisonDateRangeLabel}+ />+ }+ >+ {visitorsCell}+ </Tooltip>+ ) : (+ visitorsCell+ )++ return (+ <div+ className={+ 'flex w-full font-medium text-sm block text-gray-800 dark:text-gray-200'+ }+ >+ <div className="w-1/2">{visitorsWithTooltip}</div>+ <div className="w-1/2">{percentageWithTooltip}</div>+ </div>+ )+}++function MetricValueCell({+ row,+ metric,+ metricLabel,+ query+}: {+ row: QueryResultRow+ metric: Metric+ metricLabel: string+ query: QueryResultQuery+}) {+ const portalRef = useBodyPortalRef()++ const { value, comparison } = extractMetricValue(row, query, metric)++ const shortFormatter = MetricFormatterShort[metric]+ const longFormatter = MetricFormatterLong[metric]++ const isAbbreviated =+ value !== null && shortFormatter(value) !== longFormatter(value)+ const showTooltip = !!comparison || isAbbreviated++ const valueContent = (+ <span+ className={classNames(+ 'font-medium text-sm block text-gray-800 dark:text-gray-200',+ showTooltip && 'cursor-default'+ )}+ data-testid="metric-value"+ >+ {shortFormatter(value)}+ {comparison && (+ <ChangeArrow+ change={comparison.change}+ metric={metric}+ className="inline-block pl-1 w-4"+ hideNumber+ />+ )}+ </span>+ )++ if (!showTooltip) return valueContent++ const dateRangeLabel = formatDateRangeLabel(query.date_range)+ const comparisonDateRangeLabel = query.comparison_date_range+ ? formatDateRangeLabel(query.comparison_date_range)+ : null++ return (+ <Tooltip+ containerRef={portalRef as React.RefObject<HTMLElement>}+ info={+ <MetricValueTooltipContent+ value={value}+ comparison={comparison}+ metric={metric}+ metricLabel={metricLabel}+ dateRangeLabel={dateRangeLabel}+ comparisonDateRangeLabel={comparisonDateRangeLabel}+ />+ }+ >+ {valueContent}+ </Tooltip>+ )+}++export function IndexBreakdownRenderer({+ data,+ isPending,+ isRealtimeSilentUpdate,+ columns+}: {+ data?: QueryApiResponse+ isPending: boolean+ isRealtimeSilentUpdate: boolean+ columns: ColumnConfiguration<QueryResultRow>[] | null+}) {+ const [tappedRow, setTappedRow] = useState<string | null>(null)+ const rows = data?.results?.slice(0, MAX_ITEMS) ?? []++ if (!columns || isPending) {+ return (+ <div+ className="w-full flex flex-col justify-center"+ style={{ minHeight: `${MIN_HEIGHT}px` }}+ >+ <div className="mx-auto loading">+ <div />+ </div>+ </div>+ )+ }++ if (rows.length === 0) {+ return (+ <div+ className="w-full h-full flex flex-col justify-center"+ style={{ minHeight: `${MIN_HEIGHT}px` }}+ >+ <div className="mx-auto font-medium text-gray-500 dark:text-gray-400">+ No data yet+ </div>+ </div>+ )+ }++ return (+ <div className="h-full flex flex-col opacity-100 transition-opacity duration-300 starting:opacity-0">+ <div+ style={{ height: ROW_HEIGHT }}+ className="pt-3 w-full text-xs font-medium text-gray-500 dark:text-gray-400 flex items-center"+ >+ {columns.map((col) => (+ <div+ key={col.key}+ data-testid="report-header"+ className={classNames(+ col.width ?? 'grow w-full',+ col.align === 'right' ? 'text-right' : 'truncate'+ )}+ >+ {col.renderLabel()}+ </div>+ ))}+ </div>+ <div+ className="group/report"+ style={{ minHeight: DATA_CONTAINER_HEIGHT }}+ >+ <FlipMove disableAllAnimations={!isRealtimeSilentUpdate}>+ {rows.map((row) => {+ const dimension = row.dimensions[0]+ const isActive = tappedRow === dimension++ const handleClick = (e: React.MouseEvent) => {+ if (+ window.innerWidth < 768 &&+ !(e.target as HTMLElement).closest('a')+ ) {+ setTappedRow(isActive ? null : dimension)+ }+ }++ return (+ <div key={dimension} style={{ minHeight: ROW_HEIGHT }}>+ <div+ data-testid="report-row"+ className="group/row flex w-full items-center hover:bg-gray-100/60 dark:hover:bg-gray-850 rounded-sm md:cursor-default cursor-pointer"+ style={{ marginTop: ROW_GAP_HEIGHT }}+ onClick={handleClick}+ >+ {columns.map((col) => (+ <div+ key={col.key}+ className={classNames(+ col.width ?? 'grow w-full',+ col.align === 'right' ? 'text-right' : 'truncate'+ )}+ >+ {col.renderCell(row, isActive)}+ </div>+ ))}+ </div>+ </div>+ )+ })}+ </FlipMove>+ </div>+ </div>+ )+}++function ExternalLink({+ href,+ isActive+}: {+ href: string+ isActive?: boolean+}) {+ return (+ <a+ target="_blank"+ rel="noreferrer"+ href={href}+ className={+ isActive+ ? 'visible md:invisible md:group-hover/row:visible'+ : 'invisible md:group-hover/row:visible'+ }+ >+ <ExternalLinkIcon />+ </a>+ )+}diff --git a/assets/js/dashboard/stats/reports/list.tsx b/assets/js/dashboard/stats/reports/list-legacy.tsxsimilarity index 100%rename from assets/js/dashboard/stats/reports/list.tsxrename to assets/js/dashboard/stats/reports/list-legacy.tsxdiff --git a/assets/js/dashboard/stats/reports/metric-formatter.ts b/assets/js/dashboard/stats/reports/metric-formatter.tsindex 6367d2b396..604f1cf327 100644--- a/assets/js/dashboard/stats/reports/metric-formatter.ts+++ b/assets/js/dashboard/stats/reports/metric-formatter.ts@@ -1,4 +1,4 @@-import { Metric } from '../../../types/query-api'+import { Metric } from '../metrics'import { formatMoneyShort, formatMoneyLong } from '../../util/money'import {numberShortFormatter,@@ -8,12 +8,7 @@ import {nullable} from '../../util/number-formatter'-export type FormattableMetric =- | Metric- | 'total_visitors'- | 'current_visitors'- | 'exit_rate'- | 'conversions'+export type FormattableMetric = Metric | 'current_visitors' | 'conversions'// eslint-disable-next-line @typescript-eslint/no-explicit-anyexport type ValueType = anydiff --git a/assets/js/dashboard/stats/sources/index.js b/assets/js/dashboard/stats/sources/index.jsindex 48b8574255..8a63182bfe 100644--- a/assets/js/dashboard/stats/sources/index.js+++ b/assets/js/dashboard/stats/sources/index.js@@ -4,7 +4,7 @@ import * as storage from '../../util/storage'import * as url from '../../util/url'import * as api from '../../api'import usePrevious from '../../hooks/use-previous'-import ListReport from '../reports/list'+import ListReport from '../reports/list-legacy'import * as metrics from '../reports/metrics'import {getFiltersByKeyPrefix,diff --git a/assets/js/dashboard/stats/sources/referrer-list.js b/assets/js/dashboard/stats/sources/referrer-list.jsindex f6b6c76280..99b8a5a48f 100644--- a/assets/js/dashboard/stats/sources/referrer-list.js+++ b/assets/js/dashboard/stats/sources/referrer-list.js@@ -3,7 +3,7 @@ import * as api from '../../api'import * as url from '../../util/url'import * as metrics from '../reports/metrics'import { hasConversionGoalFilter } from '../../util/filters'-import ListReport from '../reports/list'+import ListReport from '../reports/list-legacy'import { useDashboardStateContext } from '../../dashboard-state-context'import { useSiteContext } from '../../site-context'import { SourceFavicon } from './source-favicon'diff --git a/assets/js/dashboard/util/tooltip.tsx b/assets/js/dashboard/util/tooltip.tsxindex a4a43a21cc..98febf3dec 100644--- a/assets/js/dashboard/util/tooltip.tsx+++ b/assets/js/dashboard/util/tooltip.tsx@@ -91,7 +91,7 @@ function TooltipMessage({ref={setPopperElement}style={popperStyle}{...popperAttributes}- className="z-[99] [body:has(.modal.is-open)_&]:z-[1000] px-2 py-1 rounded-sm text-sm text-gray-100 font-medium bg-gray-800 dark:bg-gray-700"+ className="pointer-events-none z-[99] [body:has(.modal.is-open)_&]:z-[1000] px-2 py-1 rounded-sm text-sm text-gray-100 font-medium bg-gray-800 dark:bg-gray-700"role="tooltip">{children}diff --git a/assets/js/types/globals.d.ts b/assets/js/types/globals.d.tsnew file mode 100644index 0000000000..95a9403976--- /dev/null+++ b/assets/js/types/globals.d.ts@@ -0,0 +1 @@+declare const BUILD_EXTRA: booleandiff --git a/e2e/tests/dashboard/breakdowns.spec.ts b/e2e/tests/dashboard/breakdowns.spec.tsindex 4e5596d913..2f8c4b4f69 100644--- a/e2e/tests/dashboard/breakdowns.spec.ts+++ b/e2e/tests/dashboard/breakdowns.spec.ts@@ -563,7 +563,7 @@ test('pages breakdown', async ({ page, request }) => {await expectHeaders(modal(page), ['Entry page',- /Visitors/,+ /Unique entrances/,/Total entrances/,/Bounce rate/,/Visit duration/@@ -599,8 +599,8 @@ test('pages breakdown', async ({ page, request }) => {).toBeVisible()await expectHeaders(modal(page), [- 'Page url',- /Visitors/,+ 'Exit page',+ /Unique exits/,/Total exits/,/Exit rate/])diff --git a/lib/plausible/stats/api_query_parser.ex b/lib/plausible/stats/api_query_parser.exindex 53af31245c..35837f1eba 100644--- a/lib/plausible/stats/api_query_parser.ex+++ b/lib/plausible/stats/api_query_parser.ex@@ -325,11 +325,11 @@ defmodule Plausible.Stats.ApiQueryParser dodefp parse_include_entry(key, _value),do: {:error, %QueryError{code: :invalid_include, message: "Invalid include key'#{i(key)}'."}}- defp parse_pagination(pagination) when is_map(pagination) do+ def parse_pagination(pagination) when is_map(pagination) do{:ok, Map.merge(@default_pagination, atomize_keys(pagination))}end- defp parse_pagination(nil), do: {:ok, @default_pagination}+ def parse_pagination(nil), do: {:ok, @default_pagination}defp atomize_keys(map) when is_map(map) doMap.new(map, fn {key, value} ->diff --git a/lib/plausible/stats/dashboard/query_parser.ex b/lib/plausible/stats/dashboard/query_parser.exindex d15f4f8de0..ebf4ca4591 100644--- a/lib/plausible/stats/dashboard/query_parser.ex+++ b/lib/plausible/stats/dashboard/query_parser.ex@@ -20,6 +20,8 @@ defmodule Plausible.Stats.Dashboard.QueryParser do{:ok, dimensions} <- ApiQueryParser.parse_dimensions(params["dimensions"]),{:ok, filters} <- ApiQueryParser.parse_filters(params["filters"]),{:ok, metrics} <- parse_metrics(params),+ {:ok, order_by} <- ApiQueryParser.parse_order_by(params["order_by"]),+ {:ok, pagination} <- ApiQueryParser.parse_pagination(params["pagination"]),{:ok, include} <- parse_include(params) do{:ok,ParsedQueryParams.new!(%{@@ -28,6 +30,8 @@ defmodule Plausible.Stats.Dashboard.QueryParser dodimensions: dimensions,filters: filters,metrics: metrics,+ order_by: order_by,+ pagination: pagination,include: include,skip_goal_existence_check: true,now: Keyword.get(opts, :now)diff --git a/lib/plausible/stats/metrics.ex b/lib/plausible/stats/metrics.exindex fc603b706e..191b3a3634 100644--- a/lib/plausible/stats/metrics.ex+++ b/lib/plausible/stats/metrics.ex@@ -19,6 +19,7 @@ defmodule Plausible.Stats.Metrics do:visit_duration,:events,:conversion_rate,+ :total_visitors,:group_conversion_rate,:time_on_page,:percentage,diff --git a/test/plausible/stats/query/query_parse_and_build_test.exs b/test/plausible/stats/query/query_parse_and_build_test.exsindex 33add7a739..0ba5271e7c 100644--- a/test/plausible/stats/query/query_parse_and_build_test.exs+++ b/test/plausible/stats/query/query_parse_and_build_test.exs@@ -92,6 +92,19 @@ defmodule Plausible.Stats.Query.QueryParseAndBuildTest doassert error =~ "Invalid metric"end+ test "public API does not recognize total_visitors metric", %{site: site} do+ params = %{+ "site_id" => site.domain,+ "metrics" => ["total_visitors"],+ "date_range" => "all"+ }++ assert {:error, %QueryError{message: error}} =+ Query.parse_and_build(site, params, now: @now)++ assert error =~ "Invalid metric"+ end+test "valid metrics passed", %{site: site} doparams = %{"site_id" => site.domain,diff --git a/test/plausible_web/controllers/api/stats_controller/pages_legacy_test.exs b/test/plausible_web/controllers/api/stats_controller/pages_legacy_test.exsnew file mode 100644index 0000000000..292813bfbe--- /dev/null+++ b/test/plausible_web/controllers/api/stats_controller/pages_legacy_test.exs@@ -0,0 +1,3525 @@+defmodule PlausibleWeb.Api.StatsController.PagesLegacyTest do+ @moduledoc """+ [DEPRECATED] Tests for the pages, entry_pages, and exit_pages+ actions in StatsController which are no longer used by the+ dashboard pages reports. Still used by Dashboard CSV export+ though, which is why we're keeping it around until the CSV+ export is migrated to v2 API.+ """+ use PlausibleWeb.ConnCase++ @user_id Enum.random(1000..9999)++ describe "GET /api/stats/:domain/pages" do+ setup [+ :create_user,+ :log_in,+ :create_site,+ :create_legacy_site_import+ ]++ test "returns top pages by visitors", %{conn: conn, site: site} do+ populate_stats(site, [+ build(:pageview, pathname: "/"),+ build(:pageview, pathname: "/"),+ build(:pageview, pathname: "/"),+ build(:pageview, pathname: "/register"),+ build(:pageview, pathname: "/register"),+ build(:pageview, pathname: "/contact")+ ])++ conn = get(conn, "/api/stats/#{site.domain}/pages?period=day")++ assert json_response(conn, 200)["results"] == [+ %{"visitors" => 3, "name" => "/", "percentage" => 50.0},+ %{"visitors" => 2, "name" => "/register", "percentage" => 33.33},+ %{"visitors" => 1, "name" => "/contact", "percentage" => 16.67}+ ]+ end++ test "returns top pages by visitors by hostname", %{conn: conn1, site: site} do+ populate_stats(site, [+ build(:pageview, pathname: "/", hostname: "a.example.com"),+ build(:pageview, pathname: "/", hostname: "b.example.com"),+ build(:pageview, pathname: "/", hostname: "d.example.com"),+ build(:pageview, pathname: "/landing", hostname: "x.example.com", user_id: 123),+ build(:pageview, pathname: "/register", hostname: "d.example.com", user_id: 123),+ build(:pageview, pathname: "/register", hostname: "d.example.com", user_id: 123),+ build(:pageview, pathname: "/register", hostname: "d.example.com"),+ build(:pageview, pathname: "/contact", hostname: "e.example.com")+ ])++ filters = Jason.encode!([[:contains, "event:hostname", [".example.com"]]])+ conn = get(conn1, "/api/stats/#{site.domain}/pages?period=day&filters=#{filters}")++ assert json_response(conn, 200)["results"] == [+ %{"visitors" => 3, "name" => "/", "percentage" => 50.0},+ %{"visitors" => 2, "name" => "/register", "percentage" => 33.33},+ %{"visitors" => 1, "name" => "/contact", "percentage" => 16.67},+ %{"visitors" => 1, "name" => "/landing", "percentage" => 16.67}+ ]++ filters = Jason.encode!([[:is, "event:hostname", ["d.example.com"]]])+ conn = get(conn1, "/api/stats/#{site.domain}/pages?period=day&filters=#{filters}")++ assert json_response(conn, 200)["results"] == [+ %{"visitors" => 2, "name" => "/register", "percentage" => 66.67},+ %{"visitors" => 1, "name" => "/", "percentage" => 33.33}+ ]+ end++ test "returns top pages with :is filter on custom pageview props", %{conn: conn, site: site} do+ populate_stats(site, [+ build(:pageview,+ pathname: "/blog/john-1",+ "meta.key": ["author"],+ "meta.value": ["John Doe"]+ ),+ build(:pageview,+ pathname: "/blog/other-post",+ "meta.key": ["author"],+ "meta.value": ["other"]+ ),+ build(:pageview, user_id: 123, pathname: "/")+ ])++ filters = Jason.encode!([[:is, "event:props:author", ["John Doe"]]])+ conn = get(conn, "/api/stats/#{site.domain}/pages?period=day&filters=#{filters}")++ assert json_response(conn, 200)["results"] == [+ %{"visitors" => 1, "name" => "/blog/john-1", "percentage" => 100.0}+ ]+ end++ test "returns top pages with :is_not filter on custom pageview props", %{+ conn: conn,+ site: site+ } do+ populate_stats(site, [+ build(:pageview,+ pathname: "/blog/john-1",+ "meta.key": ["author"],+ "meta.value": ["John Doe"]+ ),+ build(:pageview,+ pathname: "/blog/other-post",+ "meta.key": ["author"],+ "meta.value": ["other"]+ ),+ build(:pageview, pathname: "/")+ ])++ filters = Jason.encode!([[:is_not, "event:props:author", ["John Doe"]]])+ conn = get(conn, "/api/stats/#{site.domain}/pages?period=day&filters=#{filters}")++ assert json_response(conn, 200)["results"] == [+ %{"visitors" => 1, "name" => "/", "percentage" => 50.0},+ %{"visitors" => 1, "name" => "/blog/other-post", "percentage" => 50.0}+ ]+ end++ test "returns top pages with :matches_wildcard filter on custom pageview props", %{+ conn: conn,+ site: site+ } do+ populate_stats(site, [+ build(:pageview,+ pathname: "/1",+ "meta.key": ["prop"],+ "meta.value": ["bar"]+ ),+ build(:pageview,+ pathname: "/2",+ "meta.key": ["prop"],+ "meta.value": ["foobar"]+ ),+ build(:pageview,+ pathname: "/3",+ "meta.key": ["prop"],+ "meta.value": ["baar"]+ ),+ build(:pageview,+ pathname: "/4",+ "meta.key": ["another"],+ "meta.value": ["bar"]+ ),+ build(:pageview, pathname: "/5")+ ])++ filters = Jason.encode!([[:contains, "event:props:prop", ["bar"]]])+ conn = get(conn, "/api/stats/#{site.domain}/pages?period=day&filters=#{filters}")++ assert json_response(conn, 200)["results"] == [+ %{"visitors" => 1, "name" => "/1", "percentage" => 50.0},+ %{"visitors" => 1, "name" => "/2", "percentage" => 50.0}+ ]+ end++ test "returns top pages with :matches_member filter on custom pageview props", %{+ conn: conn,+ site: site+ } do+ populate_stats(site, [+ build(:pageview,+ pathname: "/1",+ "meta.key": ["prop"],+ "meta.value": ["bar"]+ ),+ build(:pageview,+ pathname: "/2",+ "meta.key": ["prop"],+ "meta.value": ["foobar"]+ ),+ build(:pageview,+ pathname: "/3",+ "meta.key": ["prop"],+ "meta.value": ["baar"]+ ),+ build(:pageview,+ pathname: "/4",+ "meta.key": ["another"],+ "meta.value": ["bar"]+ ),+ build(:pageview, pathname: "/5"),+ build(:pageview,+ pathname: "/6",+ "meta.key": ["prop"],+ "meta.value": ["near"]+ )+ ])++ filters = Jason.encode!([[:contains, "event:props:prop", ["bar", "nea"]]])+ conn = get(conn, "/api/stats/#{site.domain}/pages?period=day&filters=#{filters}")++ assert json_response(conn, 200)["results"] == [+ %{"visitors" => 1, "name" => "/1", "percentage" => 33.33},+ %{"visitors" => 1, "name" => "/2", "percentage" => 33.33},+ %{"visitors" => 1, "name" => "/6", "percentage" => 33.33}+ ]+ end++ test "returns top pages with multiple filters on custom pageview props", %{+ conn: conn,+ site: site+ } do+ populate_stats(site, [+ build(:pageview,+ pathname: "/1",+ "meta.key": ["prop", "number"],+ "meta.value": ["bar", "1"]+ ),+ build(:pageview,+ pathname: "/2",+ "meta.key": ["prop", "number"],+ "meta.value": ["bar", "2"]+ ),+ build(:pageview,+ pathname: "/3",+ "meta.key": ["prop"],+ "meta.value": ["bar"]+ ),+ build(:pageview,+ pathname: "/4",+ "meta.key": ["number"],+ "meta.value": ["bar"]+ ),+ build(:pageview, pathname: "/5")+ ])++ filters =+ Jason.encode!([+ [:is, "event:props:prop", ["bar"]],+ [:is, "event:props:number", ["1"]]+ ])++ conn = get(conn, "/api/stats/#{site.domain}/pages?period=day&filters=#{filters}")++ assert json_response(conn, 200)["results"] == [+ %{"visitors" => 1, "name" => "/1", "percentage" => 100.0}+ ]+ end++ test "calculates bounce_rate and time_on_page with :is filter on custom pageview props",+ %{conn: conn, site: site} do+ populate_stats(site, [+ build(:pageview,+ pathname: "/blog/john-1",+ "meta.key": ["author"],+ "meta.value": ["John Doe"],+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:00:00]+ ),+ build(:engagement,+ pathname: "/blog/john-1",+ "meta.key": ["author"],+ "meta.value": ["John Doe"],+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:01:00],+ engagement_time: 60_000+ ),+ build(:pageview,+ pathname: "/blog",+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:01:00]+ ),+ build(:engagement,+ pathname: "/blog",+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:02:00],+ engagement_time: 60_000+ ),+ build(:pageview,+ pathname: "/blog/john-2",+ "meta.key": ["author"],+ "meta.value": ["John Doe"],+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:02:00]+ ),+ build(:engagement,+ pathname: "/blog/john-2",+ "meta.key": ["author"],+ "meta.value": ["John Doe"],+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:02:30],+ engagement_time: 30_000+ ),+ build(:pageview,+ pathname: "/blog/john-2",+ "meta.key": ["author"],+ "meta.value": ["John Doe"],+ user_id: 456,+ timestamp: ~N[2021-01-01 00:00:00]+ ),+ build(:engagement,+ pathname: "/blog/john-2",+ "meta.key": ["author"],+ "meta.value": ["John Doe"],+ user_id: 456,+ timestamp: ~N[2021-01-01 00:10:00],+ engagement_time: 600_000+ ),+ build(:pageview,+ pathname: "/blog",+ user_id: 456,+ timestamp: ~N[2021-01-01 00:10:00]+ ),+ build(:engagement,+ pathname: "/blog",+ user_id: 456,+ timestamp: ~N[2021-01-01 00:10:30],+ engagement_time: 30_000+ )+ ])++ filters = Jason.encode!([[:is, "event:props:author", ["John Doe"]]])++ conn =+ get(+ conn,+ "/api/stats/#{site.domain}/pages?period=day&date=2021-01-01&filters=#{filters}&detailed=true"+ )++ assert json_response(conn, 200)["results"] == [+ %{+ "name" => "/blog/john-2",+ "visitors" => 2,+ "pageviews" => 2,+ "bounce_rate" => 0,+ "time_on_page" => 315,+ "scroll_depth" => 0,+ "percentage" => 100.0+ },+ %{+ "name" => "/blog/john-1",+ "visitors" => 1,+ "pageviews" => 1,+ "bounce_rate" => 0,+ "time_on_page" => 60,+ "scroll_depth" => 0,+ "percentage" => 50.0+ }+ ]+ end++ test "calculates bounce_rate and time_on_page with :is_not filter on custom pageview props",+ %{conn: conn, site: site} do+ populate_stats(site, [+ build(:pageview,+ pathname: "/blog",+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:00:00]+ ),+ build(:engagement,+ pathname: "/blog",+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:01:00],+ engagement_time: 60_000+ ),+ build(:pageview,+ pathname: "/blog/john-1",+ user_id: @user_id,+ "meta.key": ["author"],+ "meta.value": ["John Doe"],+ timestamp: ~N[2021-01-01 00:01:00]+ ),+ build(:engagement,+ pathname: "/blog/john-1",+ user_id: @user_id,+ "meta.key": ["author"],+ "meta.value": ["John Doe"],+ timestamp: ~N[2021-01-01 00:02:00],+ engagement_time: 60_000+ ),+ build(:pageview,+ pathname: "/blog/other-post",+ user_id: @user_id,+ "meta.key": ["author"],+ "meta.value": ["other"],+ timestamp: ~N[2021-01-01 00:02:00]+ ),+ build(:engagement,+ pathname: "/blog/other-post",+ user_id: @user_id,+ "meta.key": ["author"],+ "meta.value": ["other"],+ timestamp: ~N[2021-01-01 00:02:30],+ engagement_time: 30_000+ ),+ build(:pageview,+ pathname: "/blog",+ user_id: 456,+ timestamp: ~N[2021-01-01 00:00:00]+ ),+ build(:engagement,+ pathname: "/blog",+ user_id: 456,+ timestamp: ~N[2021-01-01 00:03:00],+ engagement_time: 180_000+ ),+ build(:pageview,+ pathname: "/blog/john-1",+ "meta.key": ["author"],+ "meta.value": ["John Doe"],+ user_id: 456,+ timestamp: ~N[2021-01-01 00:03:00]+ ),+ build(:engagement,+ pathname: "/blog/john-1",+ "meta.key": ["author"],+ "meta.value": ["John Doe"],+ user_id: 456,+ timestamp: ~N[2021-01-01 00:03:30],+ engagement_time: 30_000+ )+ ])++ filters = Jason.encode!([[:is_not, "event:props:author", ["John Doe"]]])++ conn =+ get(+ conn,+ "/api/stats/#{site.domain}/pages?period=day&date=2021-01-01&filters=#{filters}&detailed=true"+ )++ assert json_response(conn, 200)["results"] == [+ %{+ "name" => "/blog",+ "visitors" => 2,+ "pageviews" => 2,+ "bounce_rate" => 0,+ "time_on_page" => 120,+ "scroll_depth" => 0,+ "percentage" => 100.0+ },+ %{+ "name" => "/blog/other-post",+ "visitors" => 1,+ "pageviews" => 1,+ "bounce_rate" => 0,+ "time_on_page" => 30,+ "scroll_depth" => 0,+ "percentage" => 50.0+ }+ ]+ end++ test "calculates bounce_rate and time_on_page with :is (none) filter on custom pageview props",+ %{conn: conn, site: site} do+ populate_stats(site, [+ build(:pageview,+ pathname: "/blog",+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:00:00]+ ),+ build(:engagement,+ pathname: "/blog",+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:01:00],+ engagement_time: 60_000+ ),+ build(:pageview,+ pathname: "/blog/john-1",+ user_id: @user_id,+ "meta.key": ["author"],+ "meta.value": ["John Doe"],+ timestamp: ~N[2021-01-01 00:01:00]+ ),+ build(:engagement,+ pathname: "/blog/john-1",+ user_id: @user_id,+ "meta.key": ["author"],+ "meta.value": ["John Doe"],+ timestamp: ~N[2021-01-01 00:02:00],+ engagement_time: 60_000+ ),+ build(:pageview,+ pathname: "/blog/other-post",+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:02:00]+ ),+ build(:engagement,+ pathname: "/blog/other-post",+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:02:30],+ engagement_time: 30_000+ ),+ build(:pageview,+ pathname: "/blog",+ user_id: 456,+ timestamp: ~N[2021-01-01 00:00:00]+ ),+ build(:engagement,+ pathname: "/blog",+ user_id: 456,+ timestamp: ~N[2021-01-01 00:00:30],+ engagement_time: 30_000+ )+ ])++ filters = Jason.encode!([[:is, "event:props:author", ["(none)"]]])++ conn =+ get(+ conn,+ "/api/stats/#{site.domain}/pages?period=day&date=2021-01-01&filters=#{filters}&detailed=true"+ )++ assert json_response(conn, 200)["results"] == [+ %{+ "name" => "/blog",+ "visitors" => 2,+ "pageviews" => 2,+ "bounce_rate" => 50,+ "time_on_page" => 45,+ "scroll_depth" => 0,+ "percentage" => 100.0+ },+ %{+ "name" => "/blog/other-post",+ "visitors" => 1,+ "pageviews" => 1,+ "bounce_rate" => 0,+ "time_on_page" => 30,+ "scroll_depth" => 0,+ "percentage" => 50.0+ }+ ]+ end++ test "calculates bounce_rate and time_on_page with :is_not (none) filter on custom pageview props",+ %{conn: conn, site: site} do+ populate_stats(site, [+ build(:pageview,+ pathname: "/blog/john-1",+ user_id: @user_id,+ "meta.key": ["author"],+ "meta.value": ["John Doe"],+ timestamp: ~N[2021-01-01 00:00:00]+ ),+ build(:engagement,+ pathname: "/blog/john-1",+ user_id: @user_id,+ "meta.key": ["author"],+ "meta.value": ["John Doe"],+ timestamp: ~N[2021-01-01 00:01:00],+ engagement_time: 60_000+ ),+ build(:pageview,+ pathname: "/blog",+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:01:00]+ ),+ build(:engagement,+ pathname: "/blog",+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:02:00],+ engagement_time: 60_000+ ),+ build(:pageview,+ pathname: "/blog/other-post",+ "meta.key": ["author"],+ "meta.value": ["other"],+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:02:00]+ ),+ build(:engagement,+ pathname: "/blog/other-post",+ "meta.key": ["author"],+ "meta.value": ["other"],+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:02:30],+ engagement_time: 30_000+ ),+ build(:pageview,+ pathname: "/blog/other-post",+ "meta.key": ["author"],+ "meta.value": [""],+ user_id: 456,+ timestamp: ~N[2021-01-01 00:00:00]+ ),+ build(:engagement,+ pathname: "/blog/other-post",+ "meta.key": ["author"],+ "meta.value": [""],+ user_id: 456,+ timestamp: ~N[2021-01-01 00:00:30],+ engagement_time: 30_000+ )+ ])++ filters = Jason.encode!([[:is_not, "event:props:author", ["(none)"]]])++ conn =+ get(+ conn,+ "/api/stats/#{site.domain}/pages?period=day&date=2021-01-01&filters=#{filters}&detailed=true"+ )++ assert json_response(conn, 200)["results"] == [+ %{+ "name" => "/blog/other-post",+ "visitors" => 2,+ "pageviews" => 2,+ "bounce_rate" => 100,+ "time_on_page" => 30,+ "scroll_depth" => 0,+ "percentage" => 100.0+ },+ %{+ "name" => "/blog/john-1",+ "visitors" => 1,+ "pageviews" => 1,+ "bounce_rate" => 0,+ "time_on_page" => 60,+ "scroll_depth" => 0,+ "percentage" => 50.0+ }+ ]+ end++ test "returns top pages with :not_member filter on custom pageview props", %{+ conn: conn,+ site: site+ } do+ populate_stats(site, [+ build(:pageview,+ pathname: "/chrome",+ "meta.key": ["browser"],+ "meta.value": ["Chrome"],+ timestamp: ~N[2021-01-01 00:00:00]+ ),+ build(:pageview,+ pathname: "/chrome",+ "meta.key": ["browser"],+ "meta.value": ["Chrome"],+ timestamp: ~N[2021-01-01 00:00:00]+ ),+ build(:pageview,+ pathname: "/safari",+ "meta.key": ["browser"],+ "meta.value": ["Safari"],+ timestamp: ~N[2021-01-01 00:00:00]+ ),+ build(:pageview,+ pathname: "/firefox",+ "meta.key": ["browser"],+ "meta.value": ["Firefox"],+ timestamp: ~N[2021-01-01 00:00:00]+ ),+ build(:pageview,+ pathname: "/firefox",+ timestamp: ~N[2021-01-01 00:00:00]+ )+ ])++ filters = Jason.encode!([[:is_not, "event:props:browser", ["Chrome", "Safari"]]])++ conn =+ get(conn, "/api/stats/#{site.domain}/pages?period=day&date=2021-01-01&filters=#{filters}")++ assert json_response(conn, 200)["results"] == [+ %{+ "name" => "/firefox",+ "visitors" => 2,+ "percentage" => 100.0+ }+ ]++ assert json_response(conn, 200)["meta"] == %{"date_range_label" => "1 Jan 2021"}+ end++ test "returns top pages with :not_member filter on custom pageview props including (none) value",+ %{conn: conn, site: site} do+ populate_stats(site, [+ build(:pageview,+ pathname: "/chrome",+ "meta.key": ["browser"],+ "meta.value": ["Chrome"],+ timestamp: ~N[2021-01-01 00:00:00]+ ),+ build(:pageview,+ pathname: "/chrome",+ "meta.key": ["browser"],+ "meta.value": ["Chrome"],+ timestamp: ~N[2021-01-01 00:00:00]+ ),+ build(:pageview,+ pathname: "/safari",+ "meta.key": ["browser"],+ "meta.value": ["Safari"],+ timestamp: ~N[2021-01-01 00:00:00]+ ),+ build(:pageview,+ pathname: "/no-browser-prop",+ timestamp: ~N[2021-01-01 00:00:00]+ )+ ])++ filters = Jason.encode!([[:is_not, "event:props:browser", ["Chrome", "(none)"]]])++ conn =+ get(conn, "/api/stats/#{site.domain}/pages?period=day&date=2021-01-01&filters=#{filters}")++ assert json_response(conn, 200)["results"] == [+ %{+ "name" => "/safari",+ "visitors" => 1,+ "percentage" => 100.0+ }+ ]+ end++ test "calculates bounce_rate and time_on_page for pages filtered by page path",+ %{conn: conn, site: site} do+ populate_stats(site, [+ build(:pageview,+ pathname: "/",+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:00:00]+ ),+ build(:engagement,+ pathname: "/",+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:01:00],+ engagement_time: 60_000+ ),+ build(:pageview,+ pathname: "/about",+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:01:00]+ ),+ build(:engagement,+ pathname: "/about",+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:02:00],+ engagement_time: 60_000+ ),+ build(:pageview,+ pathname: "/",+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:02:00]+ ),+ build(:engagement,+ pathname: "/",+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:02:30],+ engagement_time: 30_000+ ),+ build(:pageview,+ pathname: "/",+ timestamp: ~N[2021-01-01 00:00:00]+ ),+ build(:pageview,+ pathname: "/about",+ user_id: 456,+ timestamp: ~N[2021-01-01 00:10:00]+ ),+ build(:engagement,+ pathname: "/about",+ user_id: 456,+ timestamp: ~N[2021-01-01 00:10:30],+ engagement_time: 30_000+ )+ ])++ filters = Jason.encode!([[:is, "event:page", ["/"]]])++ conn =+ get(+ conn,+ "/api/stats/#{site.domain}/pages?period=day&date=2021-01-01&filters=#{filters}&detailed=true"+ )++ assert json_response(conn, 200)["results"] == [+ %{+ "name" => "/",+ "visitors" => 2,+ "pageviews" => 3,+ "bounce_rate" => 50,+ "time_on_page" => 90,+ "scroll_depth" => 0,+ "percentage" => 100.0+ }+ ]+ end++ test "calculates scroll_depth", %{conn: conn, site: site} do+ t0 = ~N[2020-01-01 00:00:00]+ [t1, t2, t3] = for i <- 1..3, do: NaiveDateTime.add(t0, i, :minute)++ populate_stats(site, [+ build(:pageview, user_id: 12, pathname: "/blog", timestamp: t0),+ build(:engagement,+ user_id: 12,+ pathname: "/blog",+ timestamp: t1,+ scroll_depth: 20,+ engagement_time: 60_000+ ),+ build(:pageview, user_id: 12, pathname: "/another", timestamp: t1),+ build(:engagement,+ user_id: 12,+ pathname: "/another",+ timestamp: t2,+ scroll_depth: 24,+ engagement_time: 60_000+ ),+ build(:pageview, user_id: 34, pathname: "/blog", timestamp: t0),+ build(:engagement,+ user_id: 34,+ pathname: "/blog",+ timestamp: t1,+ scroll_depth: 17,+ engagement_time: 60_000+ ),+ build(:pageview, user_id: 34, pathname: "/another", timestamp: t1),+ build(:engagement,+ user_id: 34,+ pathname: "/another",+ timestamp: t2,+ scroll_depth: 26,+ engagement_time: 60_000+ ),+ build(:pageview, user_id: 34, pathname: "/blog", timestamp: t2),+ build(:engagement,+ user_id: 34,+ pathname: "/blog",+ timestamp: t3,+ scroll_depth: 60,+ engagement_time: 60_000+ ),+ build(:pageview, user_id: 56, pathname: "/blog", timestamp: t0),+ build(:engagement,+ user_id: 56,+ pathname: "/blog",+ timestamp: t1,+ scroll_depth: 100,+ engagement_time: 60_000+ )+ ])++ conn =+ get(+ conn,+ "/api/stats/#{site.domain}/pages?period=day&date=2020-01-01&detailed=true&order_by=#{Jason.encode!([["scroll_depth", "asc"]])}"+ )++ assert json_response(conn, 200)["results"] == [+ %{+ "name" => "/another",+ "visitors" => 2,+ "pageviews" => 2,+ "bounce_rate" => 0,+ "time_on_page" => 60,+ "scroll_depth" => 25,+ "percentage" => 66.67+ },+ %{+ "name" => "/blog",+ "visitors" => 3,+ "pageviews" => 4,+ "bounce_rate" => 33,+ "time_on_page" => 80,+ "scroll_depth" => 60,+ "percentage" => 100.0+ }+ ]+ end++ test "calculates scroll_depth from native and imported data combined", %{+ conn: conn,+ site: site,+ site_import: site_import+ } do+ populate_stats(site, [+ build(:pageview,+ user_id: @user_id,+ pathname: "/blog",+ timestamp: ~N[2020-01-01 00:00:00]+ ),+ build(:engagement,+ user_id: @user_id,+ pathname: "/blog",+ timestamp: ~N[2020-01-01 00:00:00],+ scroll_depth: 80,+ engagement_time: 20_000+ ),+ build(:imported_pages,+ date: ~D[2020-01-01],+ visitors: 3,+ pageviews: 3,+ total_time_on_page: 90,+ total_time_on_page_visits: 3,+ page: "/blog",+ total_scroll_depth: 120,+ total_scroll_depth_visits: 3+ )+ ])++ populate_stats(site, site_import.id, [+ build(:imported_visitors, date: ~D[2020-01-01]),+ build(:imported_visitors, date: ~D[2020-01-01]),+ build(:imported_visitors, date: ~D[2020-01-01])+ ])++ conn =+ get(+ conn,+ "/api/stats/#{site.domain}/pages?period=day&date=2020-01-01&detailed=true&with_imported=true&order_by=#{Jason.encode!([["scroll_depth", "desc"]])}"+ )++ assert json_response(conn, 200)["results"] == [+ %{+ "name" => "/blog",+ "visitors" => 4,+ "pageviews" => 4,+ "bounce_rate" => 100,+ "time_on_page" => 28,+ "scroll_depth" => 50,+ "percentage" => 100.0+ }+ ]+ end++ test "handles missing scroll_depth data from native and imported sources", %{+ conn: conn,+ site: site,+ site_import: site_import+ } do+ populate_stats(site, [+ build(:pageview,+ user_id: @user_id,+ pathname: "/native-and-imported",+ timestamp: ~N[2020-01-01 00:00:00]+ ),+ build(:engagement,+ user_id: @user_id,+ pathname: "/native-and-imported",+ timestamp: ~N[2020-01-01 00:01:00],+ scroll_depth: 80,+ engagement_time: 60_000+ ),+ build(:pageview,+ user_id: @user_id,+ pathname: "/native-only",+ timestamp: ~N[2020-01-01 00:01:00]+ ),+ build(:engagement,+ user_id: @user_id,+ pathname: "/native-only",+ timestamp: ~N[2020-01-01 00:02:00],+ scroll_depth: 40,+ engagement_time: 60_000+ ),+ build(:imported_pages,+ date: ~D[2020-01-01],+ visitors: 4,+ pageviews: 4,+ total_time_on_page: 180,+ total_time_on_page_visits: 4,+ page: "/native-and-imported",+ total_scroll_depth: 120,+ total_scroll_depth_visits: 3+ ),+ build(:imported_pages,+ date: ~D[2020-01-01],+ visitors: 20,+ pageviews: 30,+ total_time_on_page: 300,+ total_time_on_page_visits: 10,+ page: "/imported-only",+ total_scroll_depth: 100,+ total_scroll_depth_visits: 10+ )+ ])++ populate_stats(+ site,+ site_import.id,+ for(_ <- 1..24, do: build(:imported_visitors, date: ~D[2020-01-01]))+ )++ conn =+ get(+ conn,+ "/api/stats/#{site.domain}/pages?period=day&date=2020-01-01&detailed=true&with_imported=true&order_by=#{Jason.encode!([["scroll_depth", "desc"]])}"+ )++ assert json_response(conn, 200)["results"] == [+ %{+ "name" => "/native-and-imported",+ "visitors" => 5,+ "pageviews" => 5,+ "bounce_rate" => 0,+ "time_on_page" => 48,+ "scroll_depth" => 50,+ "percentage" => 20.0+ },+ %{+ "name" => "/native-only",+ "visitors" => 1,+ "pageviews" => 1,+ "bounce_rate" => 0,+ "time_on_page" => 60,+ "scroll_depth" => 40,+ "percentage" => 4.0+ },+ %{+ "name" => "/imported-only",+ "visitors" => 20,+ "pageviews" => 30,+ "bounce_rate" => 0,+ "time_on_page" => 30,+ "scroll_depth" => 10,+ "percentage" => 80.0+ }+ ]+ end++ test "can query scroll depth and time-on-page only from imported data, ignoring rows where scroll depth doesn't exist",+ %{+ conn: conn,+ site: site+ } do+ populate_stats(site, [+ build(:imported_pages,+ date: ~D[2020-01-01],+ visitors: 10,+ pageviews: 10,+ page: "/blog",+ total_scroll_depth: 100,+ total_scroll_depth_visits: 10,+ total_time_on_page: 300,+ total_time_on_page_visits: 5+ ),+ build(:imported_pages,+ date: ~D[2020-01-01],+ visitors: 100,+ pageviews: 150,+ page: "/blog",+ total_scroll_depth: 0,+ total_scroll_depth_visits: 0,+ total_time_on_page: 0,+ total_time_on_page_visits: 0+ )+ ])++ conn =+ get(+ conn,+ "/api/stats/#{site.domain}/pages?period=7d&date=2020-01-02&detailed=true&with_imported=true"+ )++ assert json_response(conn, 200)["results"] == [+ %{+ "name" => "/blog",+ "visitors" => 110,+ "pageviews" => 160,+ "bounce_rate" => 0,+ "time_on_page" => 60,+ "scroll_depth" => 10,+ "percentage" => nil+ }+ ]+ end++ test "can filter using the | (OR) filter",+ %{conn: conn, site: site} do+ populate_stats(site, [+ build(:pageview,+ pathname: "/",+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:00:00]+ ),+ build(:engagement,+ pathname: "/",+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:01:00],+ engagement_time: 60_000+ ),+ build(:pageview,+ pathname: "/irrelevant",+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:01:00]+ ),+ build(:engagement,+ pathname: "/irrelevant",+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:02:00],+ engagement_time: 60_000+ ),+ build(:pageview,+ pathname: "/",+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:02:00]+ ),+ build(:engagement,+ pathname: "/",+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:02:30],+ engagement_time: 30_000+ ),+ build(:pageview,+ pathname: "/",+ user_id: 123,+ timestamp: ~N[2021-01-01 00:00:00]+ ),+ build(:engagement,+ pathname: "/",+ user_id: 123,+ timestamp: ~N[2021-01-01 00:01:00],+ engagement_time: 60_000+ ),+ build(:pageview,+ pathname: "/about",+ user_id: 456,+ timestamp: ~N[2021-01-01 00:10:00]+ ),+ build(:engagement,+ pathname: "/about",+ user_id: 456,+ timestamp: ~N[2021-01-01 00:10:30],+ engagement_time: 30_000+ )+ ])++ filters = Jason.encode!([[:is, "event:page", ["/", "/about"]]])++ conn =+ get(+ conn,+ "/api/stats/#{site.domain}/pages?period=day&date=2021-01-01&filters=#{filters}&detailed=true"+ )++ assert json_response(conn, 200)["results"] == [+ %{+ "name" => "/",+ "visitors" => 2,+ "pageviews" => 3,+ "bounce_rate" => 50,+ "time_on_page" => 75,+ "scroll_depth" => 0,+ "percentage" => 66.67+ },+ %{+ "name" => "/about",+ "visitors" => 1,+ "pageviews" => 1,+ "bounce_rate" => 100,+ "time_on_page" => 30,+ "scroll_depth" => 0,+ "percentage" => 33.33+ }+ ]+ end++ test "can filter using the not_member filter type",+ %{conn: conn, site: site} do+ populate_stats(site, [+ build(:pageview,+ pathname: "/",+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:00:00]+ ),+ build(:engagement,+ pathname: "/",+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:01:00],+ engagement_time: 60_000+ ),+ build(:pageview,+ pathname: "/irrelevant",+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:01:00]+ ),+ build(:engagement,+ pathname: "/irrelevant",+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:02:00],+ engagement_time: 60_000+ ),+ build(:pageview,+ pathname: "/",+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:02:00]+ ),+ build(:engagement,+ pathname: "/",+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:02:30],+ engagement_time: 30_000+ ),+ build(:pageview,+ pathname: "/",+ user_id: 123,+ timestamp: ~N[2021-01-01 00:00:00]+ ),+ build(:engagement,+ pathname: "/",+ user_id: 123,+ timestamp: ~N[2021-01-01 00:01:00],+ engagement_time: 60_000+ ),+ build(:pageview,+ pathname: "/about",+ user_id: 456,+ timestamp: ~N[2021-01-01 00:10:00]+ ),+ build(:engagement,+ pathname: "/about",+ user_id: 456,+ timestamp: ~N[2021-01-01 00:10:30],+ engagement_time: 30_000+ )+ ])++ filters = Jason.encode!([[:is_not, "event:page", ["/irrelevant", "/about"]]])++ conn =+ get(+ conn,+ "/api/stats/#{site.domain}/pages?period=day&date=2021-01-01&filters=#{filters}&detailed=true"+ )++ assert json_response(conn, 200)["results"] == [+ %{+ "name" => "/",+ "visitors" => 2,+ "pageviews" => 3,+ "bounce_rate" => 50,+ "time_on_page" => 75,+ "scroll_depth" => 0,+ "percentage" => 100.0+ }+ ]+ end++ test "can filter using the matches_member filter type",+ %{conn: conn, site: site} do+ populate_stats(site, [+ build(:pageview,+ pathname: "/blog/post-1",+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:00:00]+ ),+ build(:engagement,+ pathname: "/blog/post-1",+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:01:00],+ engagement_time: 60_000+ ),+ build(:pageview,+ pathname: "/blog/post-2",+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:01:00]+ ),+ build(:engagement,+ pathname: "/blog/post-2",+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:01:30],+ engagement_time: 30_000+ ),+ build(:pageview,+ pathname: "/",+ user_id: 100,+ timestamp: ~N[2021-01-01 00:00:00]+ ),+ build(:engagement,+ pathname: "/",+ user_id: 100,+ timestamp: ~N[2021-01-01 00:00:30],+ engagement_time: 30_000+ ),+ build(:pageview,+ pathname: "/articles/post-1",+ user_id: 200,+ timestamp: ~N[2021-01-01 00:10:00]+ ),+ build(:engagement,+ pathname: "/articles/post-1",+ user_id: 200,+ timestamp: ~N[2021-01-01 00:10:30],+ engagement_time: 30_000+ ),+ build(:pageview,+ pathname: "/articles/post-1",+ user_id: 300,+ timestamp: ~N[2021-01-01 00:10:00]+ ),+ build(:engagement,+ pathname: "/articles/post-1",+ user_id: 300,+ timestamp: ~N[2021-01-01 00:10:30],+ engagement_time: 30_000+ )+ ])++ filters = Jason.encode!([[:contains, "event:page", ["/blog/", "/articles/"]]])++ conn =+ get(+ conn,+ "/api/stats/#{site.domain}/pages?period=day&date=2021-01-01&filters=#{filters}&detailed=true"+ )++ assert json_response(conn, 200)["results"] == [+ %{+ "name" => "/articles/post-1",+ "visitors" => 2,+ "pageviews" => 2,+ "bounce_rate" => 100,+ "time_on_page" => 30,+ "scroll_depth" => 0,+ "percentage" => 66.67+ },+ %{+ "name" => "/blog/post-1",+ "visitors" => 1,+ "pageviews" => 1,+ "bounce_rate" => 0,+ "time_on_page" => 60,+ "scroll_depth" => 0,+ "percentage" => 33.33+ },+ %{+ "name" => "/blog/post-2",+ "visitors" => 1,+ "pageviews" => 1,+ "bounce_rate" => 0,+ "time_on_page" => 30,+ "scroll_depth" => 0,+ "percentage" => 33.33+ }+ ]+ end++ test "page filter escapes brackets",+ %{conn: conn, site: site} do+ populate_stats(site, [+ build(:pageview,+ pathname: "/blog/(/post-1",+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:00:00]+ ),+ build(:engagement,+ pathname: "/blog/(/post-1",+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:01:00],+ engagement_time: 60_000+ ),+ build(:pageview,+ pathname: "/blog/(/post-2",+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:01:00]+ ),+ build(:engagement,+ pathname: "/blog/(/post-2",+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:01:30],+ engagement_time: 30_000+ ),+ build(:pageview,+ pathname: "/",+ user_id: 456,+ timestamp: ~N[2021-01-01 00:00:00]+ ),+ build(:engagement,+ pathname: "/",+ user_id: 456,+ timestamp: ~N[2021-01-01 00:00:30],+ engagement_time: 30_000+ )+ ])++ filters = Jason.encode!([[:contains, "event:page", ["/blog/(/", "/blog/)/"]]])++ conn =+ get(+ conn,+ "/api/stats/#{site.domain}/pages?period=day&date=2021-01-01&filters=#{filters}&detailed=true"+ )++ assert json_response(conn, 200)["results"] == [+ %{+ "name" => "/blog/(/post-1",+ "visitors" => 1,+ "pageviews" => 1,+ "bounce_rate" => 0,+ "time_on_page" => 60,+ "scroll_depth" => 0,+ "percentage" => 100.0+ },+ %{+ "name" => "/blog/(/post-2",+ "visitors" => 1,+ "pageviews" => 1,+ "bounce_rate" => 0,+ "time_on_page" => 30,+ "scroll_depth" => 0,+ "percentage" => 100.0+ }+ ]+ end++ test "can filter using the not_matches_member filter type",+ %{conn: conn, site: site} do+ populate_stats(site, [+ build(:pageview,+ pathname: "/blog/post-1",+ user_id: 100,+ timestamp: ~N[2021-01-01 00:00:00]+ ),+ build(:engagement,+ pathname: "/blog/post-1",+ user_id: 100,+ timestamp: ~N[2021-01-01 00:00:30],+ engagement_time: 30_000+ ),+ build(:pageview,+ pathname: "/",+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:00:00]+ ),+ build(:engagement,+ pathname: "/",+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:10:00],+ engagement_time: 600_000+ ),+ build(:pageview,+ pathname: "/about",+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:10:00]+ ),+ build(:engagement,+ pathname: "/about",+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:10:30],+ engagement_time: 30_000+ ),+ build(:pageview,+ pathname: "/",+ user_id: 200,+ timestamp: ~N[2021-01-01 00:00:00]+ ),+ build(:engagement,+ pathname: "/",+ user_id: 200,+ timestamp: ~N[2021-01-01 00:10:00],+ engagement_time: 600_000+ ),+ build(:pageview,+ pathname: "/articles/post-1",+ user_id: 300,+ timestamp: ~N[2021-01-01 00:10:00]+ ),+ build(:engagement,+ pathname: "/articles/post-1",+ user_id: 300,+ timestamp: ~N[2021-01-01 00:10:30],+ engagement_time: 30_000+ )+ ])++ filters = Jason.encode!([[:contains_not, "event:page", ["/blog/", "/articles/"]]])++ conn =+ get(+ conn,+ "/api/stats/#{site.domain}/pages?period=day&date=2021-01-01&filters=#{filters}&detailed=true"+ )++ assert json_response(conn, 200)["results"] == [+ %{+ "name" => "/",+ "visitors" => 2,+ "pageviews" => 2,+ "bounce_rate" => 50,+ "time_on_page" => 600,+ "scroll_depth" => 0,+ "percentage" => 100.0+ },+ %{+ "name" => "/about",+ "visitors" => 1,+ "pageviews" => 1,+ "bounce_rate" => 0,+ "time_on_page" => 30,+ "scroll_depth" => 0,+ "percentage" => 50.0+ }+ ]+ end++ test "returns top pages by visitors with imported data", %{conn: conn, site: site} do+ populate_stats(site, [+ build(:pageview, pathname: "/"),+ build(:pageview, pathname: "/"),+ build(:pageview, pathname: "/"),+ build(:imported_pages, page: "/"),+ build(:pageview, pathname: "/register"),+ build(:pageview, pathname: "/register"),+ build(:imported_pages, page: "/register"),+ build(:pageview, pathname: "/contact")+ ])++ conn1 = get(conn, "/api/stats/#{site.domain}/pages?period=day")++ assert json_response(conn1, 200)["results"] == [+ %{"visitors" => 3, "name" => "/", "percentage" => 50.0},+ %{"visitors" => 2, "name" => "/register", "percentage" => 33.33},+ %{"visitors" => 1, "name" => "/contact", "percentage" => 16.67}+ ]++ conn2 = get(conn, "/api/stats/#{site.domain}/pages?period=day&with_imported=true")++ assert json_response(conn2, 200)["results"] == [+ %{"visitors" => 4, "name" => "/", "percentage" => 66.67},+ %{"visitors" => 3, "name" => "/register", "percentage" => 50.0},+ %{"visitors" => 1, "name" => "/contact", "percentage" => 16.67}+ ]+ end++ test "returns scroll depth warning code", %{conn: conn, site: site} do+ conn =+ get(conn, "/api/stats/#{site.domain}/pages?period=day&detailed=true&with_imported=true")++ response = json_response(conn, 200)++ assert response["meta"]["metric_warnings"]["scroll_depth"]["code"] ==+ "no_imported_scroll_depth"+ end++ test "returns imported pages with a pageview goal filter", %{conn: conn, site: site} do+ insert(:goal, site: site, page_path: "/blog**")++ populate_stats(site, [+ build(:imported_pages, page: "/blog"),+ build(:imported_pages, page: "/not-this"),+ build(:imported_pages, page: "/blog/post-1", visitors: 2),+ build(:imported_visitors, visitors: 4)+ ])++ filters = Jason.encode!([[:is, "event:goal", ["Visit /blog**"]]])+ q = "?period=day&filters=#{filters}&with_imported=true"+ conn = get(conn, "/api/stats/#{site.domain}/pages#{q}")++ assert json_response(conn, 200)["results"] == [+ %{+ "visitors" => 2,+ "name" => "/blog/post-1",+ "conversion_rate" => 100.0,+ "total_visitors" => 2+ },+ %{+ "visitors" => 1,+ "name" => "/blog",+ "conversion_rate" => 100.0,+ "total_visitors" => 1+ }+ ]+ end++ test "calculates bounce rate and time on page for pages", %{conn: conn, site: site} do+ populate_stats(site, [+ build(:pageview,+ pathname: "/",+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:00:00]+ ),+ build(:engagement,+ pathname: "/",+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:15:00],+ engagement_time: 900_000+ ),+ build(:pageview,+ pathname: "/some-other-page",+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:15:00]+ ),+ build(:engagement,+ pathname: "/some-other-page",+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:15:30],+ engagement_time: 30_000+ ),+ build(:pageview,+ pathname: "/",+ user_id: 123,+ timestamp: ~N[2021-01-01 00:15:00]+ ),+ build(:engagement,+ pathname: "/",+ user_id: 123,+ timestamp: ~N[2021-01-01 00:15:30],+ engagement_time: 30_000+ )+ ])++ conn =+ get(+ conn,+ "/api/stats/#{site.domain}/pages?period=day&date=2021-01-01&detailed=true"+ )++ assert json_response(conn, 200)["results"] == [+ %{+ "bounce_rate" => 50.0,+ "time_on_page" => 465.0,+ "visitors" => 2,+ "pageviews" => 2,+ "name" => "/",+ "scroll_depth" => 0,+ "percentage" => 100.0+ },+ %{+ "bounce_rate" => 0,+ "time_on_page" => 30,+ "visitors" => 1,+ "pageviews" => 1,+ "name" => "/some-other-page",+ "scroll_depth" => 0,+ "percentage" => 50.0+ }+ ]+ end++ test "filtering by hostname, excludes a page on different hostname", %{conn: conn, site: site} do+ populate_stats(site, [+ build(:pageview,+ timestamp: ~N[2021-01-01 05:01:00],+ pathname: "/about",+ hostname: "blog.example.com",+ user_id: @user_id+ ),+ build(:pageview,+ timestamp: ~N[2021-01-01 05:01:02],+ pathname: "/hello",+ hostname: "example.com",+ user_id: @user_id+ ),+ build(:pageview,+ timestamp: ~N[2021-01-01 05:01:02],+ pathname: "/about",+ hostname: "blog.example.com"+ )+ ])++ filters = Jason.encode!([[:is, "event:hostname", ["blog.example.com"]]])++ conn =+ get(+ conn,+ "/api/stats/#{site.domain}/pages?period=day&date=2021-01-01&detailed=true&filters=#{filters}"+ )++ assert json_response(conn, 200)["results"] == [+ %{+ "bounce_rate" => 50,+ "name" => "/about",+ "pageviews" => 2,+ "time_on_page" => nil,+ "visitors" => 2,+ "scroll_depth" => nil,+ "percentage" => 100.0+ }+ ]+ end++ test "calculates bounce rate and time on page for pages when filtered by hostname", %{+ conn: conn,+ site: site+ } do+ populate_stats(site, [+ # session 1+ build(:pageview,+ pathname: "/about-blog",+ hostname: "blog.example.com",+ user_id: @user_id + 1,+ timestamp: ~N[2021-01-01 00:01:00]+ ),+ build(:engagement,+ pathname: "/about-blog",+ hostname: "blog.example.com",+ user_id: @user_id + 1,+ timestamp: ~N[2021-01-01 00:01:30],+ engagement_time: 30_000+ ),++ # session 2+ build(:pageview,+ pathname: "/about-blog",+ hostname: "blog.example.com",+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:01:00]+ ),+ build(:engagement,+ pathname: "/about-blog",+ hostname: "blog.example.com",+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:10:00],+ engagement_time: 540_000+ ),+ build(:pageview,+ pathname: "/about",+ hostname: "example.com",+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:10:00]+ ),+ build(:engagement,+ pathname: "/about",+ hostname: "example.com",+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:15:00],+ engagement_time: 300_000+ ),+ build(:pageview,+ pathname: "/about-blog",+ hostname: "blog.example.com",+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:15:00]+ ),+ build(:engagement,+ pathname: "/about-blog",+ hostname: "blog.example.com",+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:20:00],+ engagement_time: 300_000+ ),+ build(:pageview,+ pathname: "/exit-blog",+ hostname: "blog.example.com",+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:20:00]+ ),+ build(:engagement,+ pathname: "/exit-blog",+ hostname: "blog.example.com",+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:22:00],+ engagement_time: 120_000+ ),+ build(:pageview,+ pathname: "/about",+ hostname: "example.com",+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:22:00]+ ),+ build(:engagement,+ pathname: "/about",+ hostname: "example.com",+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:25:00],+ engagement_time: 180_000+ ),+ build(:pageview,+ pathname: "/exit",+ hostname: "example.com",+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:25:00]+ ),+ build(:engagement,+ pathname: "/exit",+ hostname: "example.com",+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:25:30],+ engagement_time: 30_000+ ),++ # session 3+ build(:pageview,+ pathname: "/about",+ hostname: "example.com",+ user_id: @user_id + 2,+ timestamp: ~N[2021-01-01 00:01:00]+ ),+ build(:engagement,+ pathname: "/about",+ hostname: "example.com",+ user_id: @user_id + 2,+ timestamp: ~N[2021-01-01 00:01:30],+ engagement_time: 30_000+ )+ ])++ filters = Jason.encode!([[:is, "event:hostname", ["blog.example.com"]]])++ conn =+ get(+ conn,+ "/api/stats/#{site.domain}/pages?period=day&date=2021-01-01&detailed=true&filters=#{filters}"+ )++ assert json_response(conn, 200)["results"] == [+ %{+ "bounce_rate" => 50,+ "name" => "/about-blog",+ "pageviews" => 3,+ "time_on_page" => 435,+ "visitors" => 2,+ "scroll_depth" => 0,+ "percentage" => 100.0+ },+ %{+ "bounce_rate" => 0,+ "name" => "/exit-blog",+ "pageviews" => 1,+ "time_on_page" => 120,+ "visitors" => 1,+ "scroll_depth" => 0,+ "percentage" => 50.0+ }+ ]+ end++ test "calculates bounce rate and time on page for pages with imported data", %{+ conn: conn,+ site: site,+ site_import: site_import+ } do+ populate_stats(site, [+ build(:pageview,+ pathname: "/",+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:00:00]+ ),+ build(:engagement,+ pathname: "/",+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:15:00],+ engagement_time: 900_000+ ),+ build(:pageview,+ pathname: "/some-other-page",+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:15:00]+ ),+ build(:engagement,+ pathname: "/some-other-page",+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:15:30],+ engagement_time: 30_000+ ),+ build(:pageview,+ pathname: "/",+ user_id: 123,+ timestamp: ~N[2021-01-01 00:15:00]+ ),+ build(:engagement,+ pathname: "/",+ user_id: 123,+ timestamp: ~N[2021-01-01 00:30:00],+ engagement_time: 900_000+ ),+ build(:imported_pages,+ page: "/",+ date: ~D[2021-01-01],+ total_time_on_page: 700,+ total_time_on_page_visits: 3+ ),+ build(:imported_entry_pages,+ entry_page: "/",+ date: ~D[2021-01-01],+ entrances: 3,+ bounces: 1+ ),+ build(:imported_pages,+ page: "/some-other-page",+ date: ~D[2021-01-01],+ total_time_on_page: 60,+ total_time_on_page_visits: 1+ )+ ])++ populate_stats(site, site_import.id, [+ build(:imported_visitors, date: ~D[2021-01-01]),+ build(:imported_visitors, date: ~D[2021-01-01]),+ build(:imported_visitors, date: ~D[2021-01-01])+ ])++ conn =+ get(+ conn,+ "/api/stats/#{site.domain}/pages?period=day&date=2021-01-01&detailed=true&with_imported=true"+ )++ assert json_response(conn, 200)["results"] == [+ %{+ "bounce_rate" => 40.0,+ "time_on_page" => 500,+ "visitors" => 3,+ "pageviews" => 3,+ "scroll_depth" => 0,+ "name" => "/",+ "percentage" => 60.0+ },+ %{+ "bounce_rate" => 0,+ "time_on_page" => 45,+ "visitors" => 2,+ "pageviews" => 2,+ "scroll_depth" => 0,+ "name" => "/some-other-page",+ "percentage" => 40.0+ }+ ]+ end++ test "returns top pages in realtime report", %{conn: conn, site: site} do+ populate_stats(site, [+ build(:pageview, pathname: "/page1"),+ build(:pageview, pathname: "/page2"),+ build(:pageview, pathname: "/page1")+ ])++ conn = get(conn, "/api/stats/#{site.domain}/pages?period=realtime")++ assert json_response(conn, 200)["results"] == [+ %{"visitors" => 2, "name" => "/page1", "percentage" => 66.67},+ %{"visitors" => 1, "name" => "/page2", "percentage" => 33.33}+ ]+ end++ test "calculates conversion_rate when filtering for goal", %{conn: conn, site: site} do+ populate_stats(site, [+ build(:pageview, user_id: 1, pathname: "/"),+ build(:pageview, user_id: 2, pathname: "/"),+ build(:pageview, user_id: 3, pathname: "/"),+ build(:event, user_id: 3, name: "Signup")+ ])++ insert(:goal, site: site, event_name: "Signup")+ filters = Jason.encode!([[:is, "event:goal", ["Signup"]]])++ conn = get(conn, "/api/stats/#{site.domain}/pages?period=day&filters=#{filters}")++ assert json_response(conn, 200)["results"] == [+ %{+ "total_visitors" => 3,+ "visitors" => 1,+ "name" => "/",+ "conversion_rate" => 33.33+ }+ ]+ end++ test "filter by :is page with imported data", %{conn: conn, site: site} do+ site_import = insert(:site_import, site: site)++ populate_stats(site, site_import.id, [+ build(:pageview, user_id: 1, pathname: "/", timestamp: ~N[2021-01-01 12:00:00]),+ build(:engagement,+ user_id: 1,+ pathname: "/",+ timestamp: ~N[2021-01-01 12:01:00],+ engagement_time: 60_000+ ),+ build(:pageview, user_id: 1, pathname: "/ignored", timestamp: ~N[2021-01-01 12:01:00]),+ build(:engagement,+ user_id: 1,+ pathname: "/ignored",+ timestamp: ~N[2021-01-01 12:02:00],+ engagement_time: 60_000+ ),+ build(:imported_entry_pages,+ entry_page: "/",+ visitors: 1,+ bounces: 1,+ date: ~D[2021-01-01]+ ),+ build(:imported_pages,+ page: "/",+ visitors: 3,+ pageviews: 3,+ total_time_on_page: 300,+ total_time_on_page_visits: 3,+ date: ~D[2021-01-01]+ ),+ build(:imported_pages, page: "/ignored", visitors: 10, date: ~D[2021-01-01])+ ])++ filters = Jason.encode!([[:is, "event:page", ["/"]]])+ q = "?period=day&date=2021-01-01&filters=#{filters}&detailed=true&with_imported=true"++ conn = get(conn, "/api/stats/#{site.domain}/pages#{q}")++ assert json_response(conn, 200)["results"] == [+ %{+ "bounce_rate" => 50,+ "name" => "/",+ "pageviews" => 4,+ "time_on_page" => 90.0,+ "visitors" => 4,+ "scroll_depth" => 0,+ "percentage" => 100.0+ }+ ]+ end++ test "filter by :member page with imported data", %{conn: conn, site: site} do+ site_import = insert(:site_import, site: site)++ populate_stats(site, site_import.id, [+ build(:pageview, user_id: 1, pathname: "/", timestamp: ~N[2021-01-01 12:00:00]),+ build(:engagement,+ user_id: 1,+ pathname: "/",+ timestamp: ~N[2021-01-01 12:01:00],+ engagement_time: 60_000+ ),+ build(:pageview, user_id: 1, pathname: "/ignored", timestamp: ~N[2021-01-01 12:01:00]),+ build(:engagement,+ user_id: 1,+ pathname: "/ignored",+ timestamp: ~N[2021-01-01 12:02:00],+ engagement_time: 60_000+ ),+ build(:imported_entry_pages,+ entry_page: "/",+ visitors: 1,+ bounces: 1,+ date: ~D[2021-01-01]+ ),+ build(:imported_entry_pages,+ entry_page: "/a",+ visitors: 1,+ bounces: 1,+ date: ~D[2021-01-01]+ ),+ build(:imported_pages,+ page: "/",+ visitors: 3,+ pageviews: 3,+ total_time_on_page: 300,+ total_time_on_page_visits: 3,+ date: ~D[2021-01-01]+ ),+ build(:imported_pages,+ page: "/a",+ visitors: 1,+ date: ~D[2021-01-01]+ ),+ build(:imported_pages, page: "/ignored", visitors: 10, date: ~D[2021-01-01])+ ])++ filters = Jason.encode!([[:is, "event:page", ["/", "/a"]]])+ q = "?period=day&date=2021-01-01&filters=#{filters}&detailed=true&with_imported=true"++ conn = get(conn, "/api/stats/#{site.domain}/pages#{q}")++ assert json_response(conn, 200)["results"] == [+ %{+ "bounce_rate" => 50,+ "name" => "/",+ "pageviews" => 4,+ "time_on_page" => 90.0,+ "visitors" => 4,+ "scroll_depth" => 0,+ "percentage" => 80.0+ },+ %{+ "bounce_rate" => 100,+ "name" => "/a",+ "pageviews" => 1,+ "time_on_page" => 10.0,+ "visitors" => 1,+ "scroll_depth" => nil,+ "percentage" => 20.0+ }+ ]+ end++ test "filter by :matches_wildcard page with imported data", %{conn: conn, site: site} do+ site_import = insert(:site_import, site: site)++ populate_stats(site, site_import.id, [+ build(:pageview, user_id: 1, pathname: "/aaa", timestamp: ~N[2021-01-01 12:00:00]),+ build(:engagement,+ user_id: 1,+ pathname: "/aaa",+ timestamp: ~N[2021-01-01 12:01:00],+ engagement_time: 60_000+ ),+ build(:pageview, user_id: 1, pathname: "/ignored", timestamp: ~N[2021-01-01 12:01:00]),+ build(:engagement,+ user_id: 1,+ pathname: "/ignored",+ timestamp: ~N[2021-01-01 12:02:00],+ engagement_time: 60_000+ ),+ build(:imported_entry_pages,+ entry_page: "/aaa",+ visitors: 1,+ bounces: 1,+ date: ~D[2021-01-01]+ ),+ build(:imported_entry_pages,+ entry_page: "/a",+ visitors: 1,+ bounces: 1,+ date: ~D[2021-01-01]+ ),+ build(:imported_pages,+ page: "/aaa",+ visitors: 3,+ pageviews: 3,+ total_time_on_page: 300,+ total_time_on_page_visits: 3,+ date: ~D[2021-01-01]+ ),+ build(:imported_pages,+ page: "/a",+ visitors: 1,+ date: ~D[2021-01-01]+ ),+ build(:imported_pages, page: "/ignored", visitors: 10, date: ~D[2021-01-01])+ ])++ filters = Jason.encode!([[:contains, "event:page", ["/a"]]])+ q = "?period=day&date=2021-01-01&filters=#{filters}&detailed=true&with_imported=true"++ conn = get(conn, "/api/stats/#{site.domain}/pages#{q}")++ assert json_response(conn, 200)["results"] == [+ %{+ "bounce_rate" => 50.0,+ "name" => "/aaa",+ "pageviews" => 4,+ "time_on_page" => 90,+ "visitors" => 4,+ "scroll_depth" => 0,+ "percentage" => 80.0+ },+ %{+ "bounce_rate" => 100.0,+ "name" => "/a",+ "pageviews" => 1,+ "time_on_page" => 10,+ "visitors" => 1,+ "scroll_depth" => nil,+ "percentage" => 20.0+ }+ ]+ end++ test "can compare with previous period", %{conn: conn, site: site} do+ populate_stats(site, [+ build(:pageview,+ pathname: "/page1",+ timestamp: ~N[2021-01-01 00:00:00]+ ),+ build(:pageview,+ pathname: "/page1",+ timestamp: ~N[2021-01-02 00:00:00]+ ),+ build(:pageview,+ pathname: "/page2",+ timestamp: ~N[2021-01-02 00:00:00]+ ),+ build(:pageview,+ pathname: "/page2",+ timestamp: ~N[2021-01-02 00:00:00]+ )+ ])++ conn =+ get(+ conn,+ "/api/stats/#{site.domain}/pages?period=day&date=2021-01-02&comparison=previous_period&detailed=true"+ )++ assert json_response(conn, 200)["results"] == [+ %{+ "bounce_rate" => 100,+ "comparison" => %{+ "bounce_rate" => 0.0,+ "pageviews" => 0,+ "time_on_page" => nil,+ "visitors" => 0,+ "scroll_depth" => nil,+ "percentage" => 0.0,+ "change" => %{+ "bounce_rate" => nil,+ "pageviews" => 100,+ "time_on_page" => nil,+ "visitors" => 100,+ "scroll_depth" => nil,+ "percentage" => 100+ }+ },+ "name" => "/page2",+ "pageviews" => 2,+ "time_on_page" => nil,+ "visitors" => 2,+ "scroll_depth" => nil,+ "percentage" => 66.67+ },+ %{+ "bounce_rate" => 100,+ "name" => "/page1",+ "pageviews" => 1,+ "time_on_page" => nil,+ "visitors" => 1,+ "scroll_depth" => nil,+ "percentage" => 33.33,+ "comparison" => %{+ "bounce_rate" => 100,+ "pageviews" => 1,+ "time_on_page" => nil,+ "visitors" => 1,+ "scroll_depth" => nil,+ "percentage" => 100.0,+ "change" => %{+ "bounce_rate" => 0,+ "pageviews" => 0,+ "time_on_page" => nil,+ "visitors" => 0,+ "scroll_depth" => nil,+ "percentage" => -67+ }+ }+ }+ ]++ assert json_response(conn, 200)["meta"] == %{+ "date_range_label" => "2 Jan 2021",+ "comparison_date_range_label" => "1 Jan 2021"+ }+ end++ on_ee do+ test "returns pages across all sites on a consolidated view", %{conn: conn, site: site} do+ another_site = new_site(team: site.team)+ cv = new_consolidated_view(site.team)++ populate_stats(site, [+ build(:pageview, pathname: "/a1", timestamp: ~N[2021-01-01 00:00:00]),+ build(:pageview, pathname: "/a2", timestamp: ~N[2021-01-01 00:00:00]),+ build(:pageview, pathname: "/a2", timestamp: ~N[2021-01-01 00:00:00])+ ])++ populate_stats(another_site, [+ build(:pageview, pathname: "/b1", timestamp: ~N[2021-01-01 00:00:00]),+ build(:pageview, pathname: "/b1", timestamp: ~N[2021-01-01 00:00:00]),+ build(:pageview, pathname: "/b1", timestamp: ~N[2021-01-01 00:00:00])+ ])++ conn =+ get(+ conn,+ "/api/stats/#{cv.domain}/pages?period=day&date=2021-01-01&detailed=true"+ )++ assert json_response(conn, 200)["results"] == [+ %{+ "bounce_rate" => 100,+ "name" => "/b1",+ "pageviews" => 3,+ "time_on_page" => nil,+ "visitors" => 3,+ "scroll_depth" => nil,+ "percentage" => 50.0+ },+ %{+ "bounce_rate" => 100,+ "name" => "/a2",+ "pageviews" => 2,+ "time_on_page" => nil,+ "visitors" => 2,+ "scroll_depth" => nil,+ "percentage" => 33.33+ },+ %{+ "bounce_rate" => 100,+ "name" => "/a1",+ "pageviews" => 1,+ "time_on_page" => nil,+ "visitors" => 1,+ "scroll_depth" => nil,+ "percentage" => 16.67+ }+ ]+ end+ end+ end++ describe "GET /api/stats/:domain/entry-pages" do+ setup [:create_user, :log_in, :create_site, :create_legacy_site_import]++ test "returns top entry pages by visitors", %{conn: conn, site: site} do+ populate_stats(site, [+ build(:pageview,+ pathname: "/page1",+ timestamp: ~N[2021-01-01 00:00:00]+ ),+ build(:pageview,+ pathname: "/page1",+ timestamp: ~N[2021-01-01 00:00:00]+ ),+ build(:pageview,+ pathname: "/page2",+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:00:00]+ ),+ build(:pageview,+ pathname: "/page2",+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:15:00]+ )+ ])++ populate_stats(site, [+ build(:pageview,+ pathname: "/page2",+ user_id: @user_id,+ timestamp: ~N[2021-01-01 23:15:00]+ )+ ])++ conn = get(conn, "/api/stats/#{site.domain}/entry-pages?period=day&date=2021-01-01")++ assert json_response(conn, 200)["results"] == [+ %{+ "visitors" => 2,+ "visits" => 2,+ "name" => "/page1",+ "visit_duration" => 0,+ "bounce_rate" => 100,+ "percentage" => 66.67+ },+ %{+ "visitors" => 1,+ "visits" => 2,+ "name" => "/page2",+ "visit_duration" => 450,+ "bounce_rate" => 50,+ "percentage" => 33.33+ }+ ]+ end++ test "returns top entry pages filtered by custom pageview props", %{conn: conn, site: site} do+ populate_stats(site, [+ build(:pageview,+ pathname: "/blog",+ user_id: 123,+ timestamp: ~N[2021-01-01 00:00:00]+ ),+ build(:pageview,+ pathname: "/blog/john-1",+ "meta.key": ["author"],+ "meta.value": ["John Doe"],+ user_id: 123,+ timestamp: ~N[2021-01-01 00:01:00]+ ),+ build(:pageview,+ pathname: "/blog/john-2",+ "meta.key": ["author"],+ "meta.value": ["John Doe"],+ timestamp: ~N[2021-01-01 00:00:00]+ ),+ build(:pageview,+ pathname: "/blog/other-post",+ "meta.key": ["author"],+ "meta.value": ["other"],+ timestamp: ~N[2021-01-01 00:00:00]+ ),+ build(:pageview,+ pathname: "/blog",+ timestamp: ~N[2021-01-01 00:00:00]+ )+ ])++ filters = Jason.encode!([[:is, "event:props:author", ["John Doe"]]])++ conn =+ get(+ conn,+ "/api/stats/#{site.domain}/entry-pages?period=day&date=2021-01-01&filters=#{filters}"+ )++ assert json_response(conn, 200)["results"] == [+ %{+ "visitors" => 1,+ "visits" => 1,+ "name" => "/blog",+ "visit_duration" => 60,+ "bounce_rate" => 0,+ "percentage" => 50.0+ },+ %{+ "visitors" => 1,+ "visits" => 1,+ "name" => "/blog/john-2",+ "visit_duration" => 0,+ "bounce_rate" => 100,+ "percentage" => 50.0+ }+ ]+ end++ test "returns top entry pages by visitors with imported data", %{conn: conn, site: site} do+ populate_stats(site, [+ build(:pageview,+ pathname: "/page1",+ timestamp: ~N[2021-01-01 00:00:00]+ ),+ build(:pageview,+ pathname: "/page1",+ timestamp: ~N[2021-01-01 00:00:00]+ ),+ build(:pageview,+ pathname: "/page2",+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:00:00]+ ),+ build(:pageview,+ pathname: "/page2",+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:15:00]+ ),+ build(:pageview,+ pathname: "/page2",+ user_id: @user_id,+ timestamp: ~N[2021-01-01 23:15:00]+ )+ ])++ populate_stats(site, [+ build(:imported_entry_pages,+ entry_page: "/page2",+ date: ~D[2021-01-01],+ entrances: 3,+ visitors: 2,+ visit_duration: 300+ )+ ])++ conn1 = get(conn, "/api/stats/#{site.domain}/entry-pages?period=day&date=2021-01-01")++ assert json_response(conn1, 200)["results"] == [+ %{+ "visitors" => 2,+ "visits" => 2,+ "name" => "/page1",+ "visit_duration" => 0,+ "bounce_rate" => 100,+ "percentage" => 66.67+ },+ %{+ "visitors" => 1,+ "visits" => 2,+ "name" => "/page2",+ "visit_duration" => 450,+ "bounce_rate" => 50,+ "percentage" => 33.33+ }+ ]++ conn2 =+ get(+ conn,+ "/api/stats/#{site.domain}/entry-pages?period=day&date=2021-01-01&with_imported=true"+ )++ assert json_response(conn2, 200)["results"] == [+ %{+ "visitors" => 3,+ "visits" => 5,+ "name" => "/page2",+ "visit_duration" => 240.0,+ "bounce_rate" => 20.0,+ "percentage" => 60.0+ },+ %{+ "visitors" => 2,+ "visits" => 2,+ "name" => "/page1",+ "visit_duration" => 0.0,+ "bounce_rate" => 100.0,+ "percentage" => 40.0+ }+ ]+ end++ test "returns top entry pages by visitors filtered by hostname",+ %{conn: conn, site: site} do+ populate_stats(site, [+ build(:pageview,+ pathname: "/page1",+ hostname: "en.example.com",+ timestamp: ~N[2021-01-01 00:00:00]+ ),+ build(:pageview,+ pathname: "/page1",+ hostname: "es.example.com",+ timestamp: ~N[2021-01-01 00:00:00]+ ),+ build(:pageview,+ pathname: "/page2",+ hostname: "en.example.com",+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:00:00]+ ),+ build(:pageview,+ pathname: "/page2",+ hostname: "es.example.com",+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:15:00]+ ),+ build(:pageview,+ pathname: "/exit",+ hostname: "es.example.com",+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:16:00]+ ),+ build(:pageview,+ pathname: "/page2",+ hostname: "es.example.com",+ timestamp: ~N[2021-01-01 23:15:00]+ )+ ])++ filters = Jason.encode!([[:is, "event:hostname", ["es.example.com"]]])++ conn =+ get(+ conn,+ "/api/stats/#{site.domain}/entry-pages?period=day&date=2021-01-01&filters=#{filters}"+ )++ # We're going to only join sessions where the exit hostname matches the filter+ assert json_response(conn, 200)["results"] == [+ %{+ "name" => "/page1",+ "visit_duration" => 0,+ "visitors" => 1,+ "visits" => 1,+ "bounce_rate" => 100,+ "percentage" => 50.0+ },+ %{+ "name" => "/page2",+ "visit_duration" => 0,+ "visitors" => 1,+ "visits" => 1,+ "bounce_rate" => 100,+ "percentage" => 50.0+ }+ ]+ end++ test "bugfix: pagination on /pages filtered by goal", %{conn: conn, site: site} do+ populate_stats(+ site,+ for i <- 1..30 do+ build(:event,+ user_id: i,+ name: "Signup",+ pathname: "/signup/#{String.pad_leading(to_string(i), 2, "0")}",+ timestamp: ~N[2021-01-01 00:01:00]+ )+ end+ )++ insert(:goal, site: site, event_name: "Signup")++ request = fn conn, opts ->+ page = Keyword.fetch!(opts, :page)+ limit = Keyword.fetch!(opts, :limit)+ filters = Jason.encode!([[:is, "event:goal", ["Signup"]]])++ conn+ |> get(+ "/api/stats/#{site.domain}/pages?date=2021-01-01&period=day&filters=#{filters}&limit=#{limit}&page=#{page}"+ )+ |> json_response(200)+ |> Map.get("results")+ |> Enum.map(fn %{"name" => "/signup/" <> seq} ->+ seq+ end)+ end++ assert List.first(request.(conn, page: 1, limit: 100)) == "01"+ assert List.last(request.(conn, page: 1, limit: 100)) == "30"+ assert List.last(request.(conn, page: 1, limit: 29)) == "29"+ assert ["01", "02"] = request.(conn, page: 1, limit: 2)+ assert ["03", "04"] = request.(conn, page: 2, limit: 2)+ assert ["01", "02", "03", "04", "05"] = request.(conn, page: 1, limit: 5)+ assert ["06", "07", "08", "09", "10"] = request.(conn, page: 2, limit: 5)+ assert ["11", "12", "13", "14", "15"] = request.(conn, page: 3, limit: 5)+ assert ["20"] = request.(conn, page: 20, limit: 1)+ assert [] = request.(conn, page: 31, limit: 1)+ end++ test "calculates conversion_rate when filtering for goal", %{conn: conn, site: site} do+ populate_stats(site, [+ build(:pageview,+ pathname: "/page1",+ user_id: 1,+ timestamp: ~N[2021-01-01 00:00:00]+ ),+ build(:pageview,+ pathname: "/page1",+ user_id: 2,+ timestamp: ~N[2021-01-01 00:00:00]+ ),+ build(:event,+ name: "Signup",+ user_id: 1,+ timestamp: ~N[2021-01-01 00:00:00]+ ),+ build(:pageview,+ pathname: "/page2",+ user_id: 3,+ timestamp: ~N[2021-01-01 00:00:00]+ ),+ build(:pageview,+ pathname: "/page2",+ user_id: 3,+ timestamp: ~N[2021-01-01 00:15:00]+ ),+ build(:event,+ name: "Signup",+ user_id: 3,+ timestamp: ~N[2021-01-01 00:15:00]+ )+ ])++ insert(:goal, site: site, event_name: "Signup")+ filters = Jason.encode!([[:is, "event:goal", ["Signup"]]])++ conn =+ get(+ conn,+ "/api/stats/#{site.domain}/entry-pages?period=day&date=2021-01-01&filters=#{filters}"+ )++ assert json_response(conn, 200)["results"] == [+ %{+ "total_visitors" => 2,+ "visitors" => 1,+ "name" => "/page1",+ "conversion_rate" => 50.0+ },+ %{+ "total_visitors" => 1,+ "visitors" => 1,+ "name" => "/page2",+ "conversion_rate" => 100.0+ }+ ]+ end++ test "ignores entry pages from sessions with only custom events", %{conn: conn, site: site} do+ populate_stats(site, [+ build(:event,+ name: "Signup",+ timestamp: ~N[2021-01-01 00:15:00],+ pathname: "/"+ )+ ])++ conn =+ get(+ conn,+ "/api/stats/#{site.domain}/entry-pages?period=day&date=2021-01-01"+ )++ assert json_response(conn, 200)["results"] == []+ end++ test "filter by :matches_member entry_page with imported data", %{conn: conn, site: site} do+ site_import = insert(:site_import, site: site)++ populate_stats(site, site_import.id, [+ build(:pageview, pathname: "/aaa", timestamp: ~N[2021-01-01 12:00:00]),+ build(:pageview, pathname: "/a", timestamp: ~N[2021-01-01 12:00:00]),+ build(:pageview, pathname: "/ignored", timestamp: ~N[2021-01-01 12:01:00]),+ build(:imported_entry_pages,+ entry_page: "/a",+ visitors: 5,+ entrances: 9,+ visit_duration: 1000,+ date: ~D[2021-01-01]+ ),+ build(:imported_entry_pages,+ entry_page: "/bbb",+ visitors: 2,+ entrances: 2,+ visit_duration: 100,+ date: ~D[2021-01-01]+ )+ ])++ filters = Jason.encode!([[:contains, "visit:entry_page", ["/a", "/b"]]])+ q = "?period=day&date=2021-01-01&filters=#{filters}&detailed=true&with_imported=true"++ conn = get(conn, "/api/stats/#{site.domain}/entry-pages#{q}")++ assert json_response(conn, 200)["results"] == [+ %{+ "visit_duration" => 100.0,+ "name" => "/a",+ "visits" => 10,+ "visitors" => 6,+ "bounce_rate" => 10.0,+ "percentage" => 66.67+ },+ %{+ "visit_duration" => 50.0,+ "name" => "/bbb",+ "visits" => 2,+ "visitors" => 2,+ "bounce_rate" => 0.0,+ "percentage" => 22.22+ },+ %{+ "visit_duration" => 0,+ "name" => "/aaa",+ "visits" => 1,+ "visitors" => 1,+ "bounce_rate" => 100.0,+ "percentage" => 11.11+ }+ ]+ end+ end++ describe "GET /api/stats/:domain/exit-pages" do+ setup [:create_user, :log_in, :create_site, :create_legacy_site_import]++ test "returns top exit pages by visitors", %{conn: conn, site: site} do+ populate_stats(site, [+ build(:pageview,+ pathname: "/page1",+ timestamp: ~N[2021-01-01 00:00:00]+ ),+ build(:pageview,+ pathname: "/page1",+ timestamp: ~N[2021-01-01 00:00:00]+ ),+ build(:pageview,+ pathname: "/page1",+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:00:00]+ ),+ build(:pageview,+ pathname: "/page2",+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:15:00]+ )+ ])++ conn = get(conn, "/api/stats/#{site.domain}/exit-pages?period=day&date=2021-01-01")++ assert json_response(conn, 200)["results"] == [+ %{+ "name" => "/page1",+ "visitors" => 2,+ "visits" => 2,+ "exit_rate" => 66.7,+ "percentage" => 66.67+ },+ %{+ "name" => "/page2",+ "visitors" => 1,+ "visits" => 1,+ "exit_rate" => 100,+ "percentage" => 33.33+ }+ ]+ end++ test "returns top exit pages by ascending visits", %{conn: conn, site: site} do+ populate_stats(site, [+ build(:pageview,+ pathname: "/page1",+ timestamp: ~N[2021-01-01 00:00:00]+ ),+ build(:pageview,+ pathname: "/page1",+ timestamp: ~N[2021-01-01 00:00:00]+ ),+ build(:pageview,+ pathname: "/page1",+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:00:00]+ ),+ build(:pageview,+ pathname: "/page2",+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:15:00]+ )+ ])++ conn =+ get(+ conn,+ "/api/stats/#{site.domain}/exit-pages?period=day&date=2021-01-01&order_by=#{Jason.encode!([["visits", "asc"]])}"+ )++ assert json_response(conn, 200)["results"] == [+ %{+ "name" => "/page2",+ "visitors" => 1,+ "visits" => 1,+ "exit_rate" => 100.0,+ "percentage" => 33.33+ },+ %{+ "name" => "/page1",+ "visitors" => 2,+ "visits" => 2,+ "exit_rate" => 66.7,+ "percentage" => 66.67+ }+ ]+ end++ test "returns top exit pages by visitors filtered by hostname",+ %{conn: conn, site: site} do+ populate_stats(site, [+ build(:pageview,+ pathname: "/page1",+ hostname: "en.example.com",+ timestamp: ~N[2021-01-01 00:00:00]+ ),+ build(:pageview,+ pathname: "/page1",+ hostname: "es.example.com",+ timestamp: ~N[2021-01-01 00:00:00]+ ),+ build(:pageview,+ pathname: "/page1",+ hostname: "en.example.com",+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:00:00]+ ),+ build(:pageview,+ pathname: "/page2",+ hostname: "es.example.com",+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:15:00]+ ),+ build(:pageview,+ pathname: "/exit",+ hostname: "en.example.com",+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:16:00]+ )+ ])++ filters = Jason.encode!([[:is, "event:hostname", ["es.example.com"]]])++ conn =+ get(+ conn,+ "/api/stats/#{site.domain}/exit-pages?period=day&date=2021-01-01&filters=#{filters}"+ )++ # We're going to only join sessions where the entry hostname matches the filter+ assert json_response(conn, 200)["results"] ==+ [%{"name" => "/page1", "visitors" => 1, "visits" => 1, "percentage" => 100.0}]+ end++ test "returns top exit pages filtered by custom pageview props", %{conn: conn, site: site} do+ populate_stats(site, [+ build(:pageview,+ pathname: "/blog/john-1",+ "meta.key": ["author"],+ "meta.value": ["John Doe"],+ user_id: 123,+ timestamp: ~N[2021-01-01 00:00:00]+ ),+ build(:pageview,+ pathname: "/",+ user_id: 123,+ timestamp: ~N[2021-01-01 00:01:00]+ ),+ build(:pageview,+ pathname: "/blog/other-post",+ "meta.key": ["author"],+ "meta.value": ["other"],+ timestamp: ~N[2021-01-01 00:00:00]+ ),+ build(:pageview,+ pathname: "/",+ timestamp: ~N[2021-01-01 00:00:00]+ )+ ])++ filters = Jason.encode!([[:is, "event:props:author", ["John Doe"]]])++ conn =+ get(+ conn,+ "/api/stats/#{site.domain}/exit-pages?period=day&date=2021-01-01&filters=#{filters}"+ )++ assert json_response(conn, 200)["results"] == [+ %{"name" => "/", "visitors" => 1, "visits" => 1, "percentage" => 100.0}+ ]+ end++ test "returns top exit pages by visitors with imported data", %{conn: conn, site: site} do+ populate_stats(site, [+ build(:pageview,+ pathname: "/page1",+ timestamp: ~N[2021-01-01 00:00:00]+ ),+ build(:pageview,+ pathname: "/page1",+ timestamp: ~N[2021-01-01 00:00:00]+ ),+ build(:pageview,+ pathname: "/page1",+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:00:00]+ ),+ build(:pageview,+ pathname: "/page2",+ user_id: @user_id,+ timestamp: ~N[2021-01-01 00:15:00]+ )+ ])++ populate_stats(site, [+ build(:imported_pages,+ page: "/page2",+ date: ~D[2021-01-01],+ pageviews: 4,+ visitors: 2+ ),+ build(:imported_exit_pages,+ exit_page: "/page2",+ date: ~D[2021-01-01],+ exits: 3,+ visitors: 2+ )+ ])++ conn1 = get(conn, "/api/stats/#{site.domain}/exit-pages?period=day&date=2021-01-01")++ assert json_response(conn1, 200)["results"] == [+ %{+ "name" => "/page1",+ "visitors" => 2,+ "visits" => 2,+ "exit_rate" => 66.7,+ "percentage" => 66.67+ },+ %{+ "name" => "/page2",+ "visitors" => 1,+ "visits" => 1,+ "exit_rate" => 100.0,+ "percentage" => 33.33+ }+ ]++ conn2 =+ get(+ conn,+ "/api/stats/#{site.domain}/exit-pages?period=day&date=2021-01-01&with_imported=true"+ )++ assert json_response(conn2, 200)["results"] == [+ %{+ "name" => "/page2",+ "visitors" => 3,+ "visits" => 4,+ "exit_rate" => 80.0,+ "percentage" => 60.0+ },+ %{+ "name" => "/page1",+ "visitors" => 2,+ "visits" => 2,+ "exit_rate" => 66.7,+ "percentage" => 40.0+ }+ ]+ end++ test "calculates correct exit rate and conversion_rate when filtering for goal", %{+ conn: conn,+ site: site+ } do+ populate_stats(site, [+ build(:event,+ name: "Signup",+ user_id: 1,+ timestamp: ~N[2021-01-01 00:00:00]+ ),+ build(:pageview,+ user_id: 1,+ pathname: "/exit1",+ timestamp: ~N[2021-01-01 00:00:00]+ ),+ build(:event,+ name: "Signup",+ user_id: 2,+ timestamp: ~N[2021-01-01 00:00:00]+ ),+ build(:pageview,+ user_id: 2,+ pathname: "/exit1",+ timestamp: ~N[2021-01-01 00:00:00]+ ),+ build(:pageview,+ user_id: 2,+ pathname: "/exit2",+ timestamp: ~N[2021-01-01 00:00:00]+ )+ ])++ insert(:goal, site: site, event_name: "Signup")+ filters = Jason.encode!([[:is, "event:goal", ["Signup"]]])++ conn =+ get(+ conn,+ "/api/stats/#{site.domain}/exit-pages?period=day&date=2021-01-01&filters=#{filters}"+ )++ assert json_response(conn, 200)["results"] == [+ %{+ "name" => "/exit1",+ "visitors" => 1,+ "total_visitors" => 1,+ "conversion_rate" => 100.0+ },+ %{+ "name" => "/exit2",+ "visitors" => 1,+ "total_visitors" => 1,+ "conversion_rate" => 100.0+ }+ ]+ end++ test "calculates correct exit rate when filtering for page", %{conn: conn, site: site} do+ populate_stats(site, [+ build(:pageview,+ user_id: 1,+ pathname: "/exit1",+ timestamp: ~N[2021-01-01 00:00:00]+ ),+ build(:pageview,+ user_id: 2,+ pathname: "/exit1",+ timestamp: ~N[2021-01-01 00:00:00]+ ),+ build(:pageview,+ user_id: 2,+ pathname: "/exit2",+ timestamp: ~N[2021-01-01 00:00:00]+ ),+ build(:pageview,+ user_id: 3,+ pathname: "/exit2",+ timestamp: ~N[2021-01-01 00:00:00]+ ),+ build(:pageview,+ user_id: 3,+ pathname: "/should-not-appear",+ timestamp: ~N[2021-01-01 00:00:00]+ )+ ])++ filters = Jason.encode!([[:is, "event:page", ["/exit1"]]])++ conn =+ get(+ conn,+ "/api/stats/#{site.domain}/exit-pages?period=day&date=2021-01-01&filters=#{filters}"+ )++ assert json_response(conn, 200)["results"] == [+ %{"name" => "/exit1", "visitors" => 1, "visits" => 1, "percentage" => 50.0},+ %{"name" => "/exit2", "visitors" => 1, "visits" => 1, "percentage" => 50.0}+ ]+ end++ test "ignores exit pages from sessions with only custom events", %{conn: conn, site: site} do+ populate_stats(site, [+ build(:event,+ name: "Signup",+ timestamp: ~N[2021-01-01 00:15:00],+ pathname: "/"+ )+ ])++ conn =+ get(+ conn,+ "/api/stats/#{site.domain}/exit-pages?period=day&date=2021-01-01"+ )++ assert json_response(conn, 200)["results"] == []+ end++ test "filter by :is_not exit_page with imported data", %{conn: conn, site: site} do+ site_import = insert(:site_import, site: site)++ populate_stats(site, site_import.id, [+ build(:pageview, pathname: "/aaa", timestamp: ~N[2021-01-01 12:00:00]),+ build(:pageview, pathname: "/a", timestamp: ~N[2021-01-01 12:00:00]),+ build(:pageview, pathname: "/ignored", timestamp: ~N[2021-01-01 12:01:00]),+ build(:imported_exit_pages,+ exit_page: "/a",+ visitors: 5,+ exits: 9,+ visit_duration: 1000,+ date: ~D[2021-01-01]+ ),+ build(:imported_exit_pages,+ exit_page: "/bbb",+ visitors: 2,+ exits: 2,+ visit_duration: 100,+ date: ~D[2021-01-01]+ ),+ build(:imported_pages, page: "/a", pageviews: 19, date: ~D[2021-01-01]),+ build(:imported_pages, page: "/bbb", pageviews: 2, date: ~D[2021-01-01])+ ])++ filters = Jason.encode!([[:is_not, "visit:exit_page", ["/ignored"]]])+ q = "?period=day&date=2021-01-01&filters=#{filters}&detailed=true&with_imported=true"++ conn = get(conn, "/api/stats/#{site.domain}/exit-pages#{q}")++ assert json_response(conn, 200)["results"] == [+ %{+ "exit_rate" => 50.0,+ "name" => "/a",+ "visits" => 10,+ "visitors" => 6,+ "percentage" => 66.67+ },+ %{+ "exit_rate" => 100.0,+ "name" => "/bbb",+ "visits" => 2,+ "visitors" => 2,+ "percentage" => 22.22+ },+ %{+ "exit_rate" => 100.0,+ "name" => "/aaa",+ "visits" => 1,+ "visitors" => 1,+ "percentage" => 11.11+ }+ ]+ end++ @tag :ee_only+ test "return revenue metrics for entry pages breakdown", %{conn: conn, site: site} do+ populate_stats(site, [+ build(:pageview, user_id: 1, pathname: "/first"),+ build(:event,+ name: "Payment",+ user_id: 1,+ revenue_reporting_amount: Decimal.new("2000"),+ revenue_reporting_currency: "USD"+ ),+ build(:pageview, user_id: 2, pathname: "/second"),+ build(:event,+ user_id: 2,+ name: "Payment",+ revenue_reporting_amount: Decimal.new("3000"),+ revenue_reporting_currency: "USD"+ ),+ build(:event,+ name: "Payment",+ user_id: 2,+ revenue_reporting_amount: Decimal.new("4000"),+ revenue_reporting_currency: "USD"+ ),+ build(:pageview, user_id: 3, pathname: "/first"),+ build(:event,+ name: "Payment",+ user_id: 3,+ revenue_reporting_amount: Decimal.new("1000"),+ revenue_reporting_currency: "USD"+ ),+ build(:pageview, user_id: 4, pathname: "/third"),+ build(:event,+ name: "Payment",+ user_id: 4,+ revenue_reporting_amount: Decimal.new("2500"),+ revenue_reporting_currency: "USD"+ ),+ build(:event, name: "Payment", revenue_reporting_amount: nil),+ build(:event, name: "Payment", revenue_reporting_amount: nil)+ ])++ insert(:goal, %{site: site, event_name: "Payment", currency: :USD})++ filters = Jason.encode!([[:is, "event:goal", ["Payment"]]])+ order_by = Jason.encode!([["visitors", "desc"]])++ q = "?filters=#{filters}&order_by=#{order_by}&detailed=true&period=day&page=1&limit=100"++ conn =+ get(+ conn,+ "/api/stats/#{site.domain}/entry-pages#{q}"+ )++ assert json_response(conn, 200)["results"] == [+ %{+ "average_revenue" => %{+ "currency" => "USD",+ "long" => "$1,500.00",+ "short" => "$1.5K",+ "value" => 1500.0+ },+ "conversion_rate" => 100.0,+ "name" => "/first",+ "total_revenue" => %{+ "currency" => "USD",+ "long" => "$3,000.00",+ "short" => "$3.0K",+ "value" => 3000.0+ },+ "total_visitors" => 2,+ "visitors" => 2+ },+ %{+ "average_revenue" => %{+ "currency" => "USD",+ "long" => "$3,500.00",+ "short" => "$3.5K",+ "value" => 3500.0+ },+ "conversion_rate" => 100.0,+ "name" => "/second",+ "total_revenue" => %{+ "currency" => "USD",+ "long" => "$7,000.00",+ "short" => "$7.0K",+ "value" => 7000.0+ },+ "total_visitors" => 1,+ "visitors" => 1+ },+ %{+ "average_revenue" => %{+ "currency" => "USD",+ "long" => "$2,500.00",+ "short" => "$2.5K",+ "value" => 2500.0+ },+ "conversion_rate" => 100.0,+ "name" => "/third",+ "total_revenue" => %{+ "currency" => "USD",+ "long" => "$2,500.00",+ "short" => "$2.5K",+ "value" => 2500.0+ },+ "total_visitors" => 1,+ "visitors" => 1+ }+ ]+ end++ @tag :ee_only+ test "return revenue metrics for exit pages breakdown", %{conn: conn, site: site} do+ populate_stats(site, [+ build(:pageview, user_id: 1, pathname: "/first"),+ build(:event,+ name: "Payment",+ user_id: 1,+ revenue_reporting_amount: Decimal.new("2000"),+ revenue_reporting_currency: "USD"+ ),+ build(:pageview, user_id: 1, pathname: "/exit_first"),+ build(:pageview, user_id: 2, pathname: "/second"),+ build(:event,+ user_id: 2,+ name: "Payment",+ revenue_reporting_amount: Decimal.new("3000"),+ revenue_reporting_currency: "USD"+ ),+ build(:event,+ name: "Payment",+ user_id: 2,+ revenue_reporting_amount: Decimal.new("4000"),+ revenue_reporting_currency: "USD"+ ),+ build(:pageview, user_id: 2, pathname: "/exit_second"),+ build(:pageview, user_id: 3, pathname: "/first"),+ build(:event,+ name: "Payment",+ user_id: 3,+ revenue_reporting_amount: Decimal.new("1000"),+ revenue_reporting_currency: "USD"+ ),+ build(:pageview, user_id: 3, pathname: "/exit_first"),+ build(:pageview, user_id: 4, pathname: "/third"),+ build(:event,+ name: "Payment",+ user_id: 4,+ revenue_reporting_amount: Decimal.new("2500"),+ revenue_reporting_currency: "USD"+ ),+ build(:event, name: "Payment", revenue_reporting_amount: nil),+ build(:event, name: "Payment", revenue_reporting_amount: nil)+ ])++ insert(:goal, %{site: site, event_name: "Payment", currency: :USD})++ filters = Jason.encode!([[:is, "event:goal", ["Payment"]]])+ order_by = Jason.encode!([["visitors", "desc"]])++ q = "?filters=#{filters}&order_by=#{order_by}&detailed=true&period=day&page=1&limit=100"++ conn =+ get(+ conn,+ "/api/stats/#{site.domain}/exit-pages#{q}"+ )++ assert json_response(conn, 200)["results"] == [+ %{+ "average_revenue" => %{+ "currency" => "USD",+ "long" => "$1,500.00",+ "short" => "$1.5K",+ "value" => 1500.0+ },+ "conversion_rate" => 100.0,+ "name" => "/exit_first",+ "total_revenue" => %{+ "currency" => "USD",+ "long" => "$3,000.00",+ "short" => "$3.0K",+ "value" => 3000.0+ },+ "total_visitors" => 2,+ "visitors" => 2+ },+ %{+ "average_revenue" => %{+ "currency" => "USD",+ "long" => "$3,500.00",+ "short" => "$3.5K",+ "value" => 3500.0+ },+ "conversion_rate" => 100.0,+ "name" => "/exit_second",+ "total_revenue" => %{+ "currency" => "USD",+ "long" => "$7,000.00",+ "short" => "$7.0K",+ "value" => 7000.0+ },+ "total_visitors" => 1,+ "visitors" => 1+ },+ %{+ "average_revenue" => %{+ "currency" => "USD",+ "long" => "$2,500.00",+ "short" => "$2.5K",+ "value" => 2500.0+ },+ "conversion_rate" => 100.0,+ "name" => "/third",+ "total_revenue" => %{+ "currency" => "USD",+ "long" => "$2,500.00",+ "short" => "$2.5K",+ "value" => 2500.0+ },+ "total_visitors" => 1,+ "visitors" => 1+ }+ ]+ end++ @tag :ee_only+ test "return revenue metrics for pages breakdown", %{conn: conn, site: site} do+ populate_stats(site, [+ build(:pageview, user_id: 1, pathname: "/first"),+ build(:event,+ name: "Payment",+ pathname: "/purchase/first",+ user_id: 1,+ revenue_reporting_amount: Decimal.new("2000"),+ revenue_reporting_currency: "USD"+ ),+ build(:pageview, user_id: 1, pathname: "/exit_first"),+ build(:pageview, user_id: 2, pathname: "/second"),+ build(:event,+ user_id: 2,+ name: "Payment",+ pathname: "/purchase/second",+ revenue_reporting_amount: Decimal.new("3000"),+ revenue_reporting_currency: "USD"+ ),+ build(:event,+ name: "Payment",+ pathname: "/purchase/second",+ user_id: 2,+ revenue_reporting_amount: Decimal.new("4000"),+ revenue_reporting_currency: "USD"+ ),+ build(:pageview, user_id: 2, pathname: "/exit_second"),+ build(:pageview, user_id: 3, pathname: "/first"),+ build(:event,+ name: "Payment",+ pathname: "/purchase/first",+ user_id: 3,+ revenue_reporting_amount: Decimal.new("1000"),+ revenue_reporting_currency: "USD"+ ),+ build(:pageview, user_id: 3, pathname: "/exit_first"),+ build(:pageview, user_id: 4, pathname: "/third"),+ build(:event,+ name: "Payment",+ pathname: "/purchase/third",+ user_id: 4,+ revenue_reporting_amount: Decimal.new("2500"),+ revenue_reporting_currency: "USD"+ ),+ build(:event, name: "Payment", pathname: "/nopay", revenue_reporting_amount: nil),+ build(:event, name: "Payment", pathname: "/nopay", revenue_reporting_amount: nil),+ build(:event, name: "Payment", pathname: "/nopay", revenue_reporting_amount: nil)+ ])++ insert(:goal, %{site: site, event_name: "Payment", currency: :USD})++ filters = Jason.encode!([[:is, "event:goal", ["Payment"]]])+ order_by = Jason.encode!([["visitors", "desc"]])++ q = "?filters=#{filters}&order_by=#{order_by}&detailed=true&period=day&page=1&limit=100"++ conn =+ get(+ conn,+ "/api/stats/#{site.domain}/pages#{q}"+ )++ assert json_response(conn, 200)["results"] == [+ %{+ "average_revenue" => %{+ "currency" => "USD",+ "long" => "$0.00",+ "short" => "$0.0",+ "value" => 0.0+ },+ "conversion_rate" => 100.0,+ "name" => "/nopay",+ "total_revenue" => %{+ "currency" => "USD",+ "long" => "$0.00",+ "short" => "$0.0",+ "value" => 0.0+ },+ "total_visitors" => 3,+ "visitors" => 3+ },+ %{+ "average_revenue" => %{+ "currency" => "USD",+ "long" => "$1,500.00",+ "short" => "$1.5K",+ "value" => 1500.0+ },+ "conversion_rate" => 100.0,+ "name" => "/purchase/first",+ "total_revenue" => %{+ "currency" => "USD",+ "long" => "$3,000.00",+ "short" => "$3.0K",+ "value" => 3000.0+ },+ "total_visitors" => 2,+ "visitors" => 2+ },+ %{+ "average_revenue" => %{+ "currency" => "USD",+ "long" => "$3,500.00",+ "short" => "$3.5K",+ "value" => 3500.0+ },+ "conversion_rate" => 100.0,+ "name" => "/purchase/second",+ "total_revenue" => %{+ "currency" => "USD",+ "long" => "$7,000.00",+ "short" => "$7.0K",+ "value" => 7000.0+ },+ "total_visitors" => 1,+ "visitors" => 1+ },+ %{+ "average_revenue" => %{+ "currency" => "USD",+ "long" => "$2,500.00",+ "short" => "$2.5K",+ "value" => 2500.0+ },+ "conversion_rate" => 100.0,+ "name" => "/purchase/third",+ "total_revenue" => %{+ "currency" => "USD",+ "long" => "$2,500.00",+ "short" => "$2.5K",+ "value" => 2500.0+ },+ "total_visitors" => 1,+ "visitors" => 1+ }+ ]+ end+ end+enddiff --git a/test/plausible_web/controllers/api/stats_controller/pages_test.exs b/test/plausible_web/controllers/api/stats_controller/pages_test.exsindex 5220a1b939..9b484bd45a 100644--- a/test/plausible_web/controllers/api/stats_controller/pages_test.exs+++ b/test/plausible_web/controllers/api/stats_controller/pages_test.exs@@ -3,6 +3,34 @@ defmodule PlausibleWeb.Api.StatsController.PagesTest do@user_id Enum.random(1000..9999)+ @default_metrics ["visitors", "percentage"]+ @detailed_metrics [+ "visitors",+ "pageviews",+ "bounce_rate",+ "time_on_page",+ "scroll_depth",+ "percentage"+ ]+ @goal_filter_metrics ["visitors", "group_conversion_rate", "total_visitors"]++ defp query_pages(conn, site, opts) do+ params = %{+ "dimensions" => Keyword.get(opts, :dimensions, ["event:page"]),+ "date_range" => Keyword.get(opts, :date_range, "all"),+ "relative_date" => Keyword.get(opts, :relative_date, nil),+ "filters" => Keyword.get(opts, :filters, []),+ "metrics" => Keyword.get(opts, :metrics, @default_metrics),+ "include" => Keyword.get(opts, :include, nil),+ "pagination" => Keyword.get(opts, :pagination, nil),+ "order_by" => Keyword.get(opts, :order_by, nil)+ }++ conn+ |> post("/api/stats/#{site.domain}/query", params)+ |> json_response(200)+ end+describe "GET /api/stats/:domain/pages" dosetup [:create_user,@@ -21,16 +49,16 @@ defmodule PlausibleWeb.Api.StatsController.PagesTest dobuild(:pageview, pathname: "/contact")])- conn = get(conn, "/api/stats/#{site.domain}/pages?period=day")+ response = query_pages(conn, site, date_range: "day")- assert json_response(conn, 200)["results"] == [- %{"visitors" => 3, "name" => "/", "percentage" => 50.0},- %{"visitors" => 2, "name" => "/register", "percentage" => 33.33},- %{"visitors" => 1, "name" => "/contact", "percentage" => 16.67}+ assert response["results"] == [+ %{"dimensions" => ["/"], "metrics" => [3, 50.0]},+ %{"dimensions" => ["/register"], "metrics" => [2, 33.33]},+ %{"dimensions" => ["/contact"], "metrics" => [1, 16.67]}]end- test "returns top pages by visitors by hostname", %{conn: conn1, site: site} do+ test "returns top pages by visitors by hostname", %{conn: conn, site: site} dopopulate_stats(site, [build(:pageview, pathname: "/", hostname: "a.example.com"),build(:pageview, pathname: "/", hostname: "b.example.com"),@@ -42,22 +70,29 @@ defmodule PlausibleWeb.Api.StatsController.PagesTest dobuild(:pageview, pathname: "/contact", hostname: "e.example.com")])- filters = Jason.encode!([[:contains, "event:hostname", [".example.com"]]])- conn = get(conn1, "/api/stats/#{site.domain}/pages?period=day&filters=#{filters}")+ response =+ query_pages(conn, site,+ date_range: "day",+ filters: [["contains", "event:hostname", [".example.com"]]],+ order_by: [["visitors", "desc"], ["event:page", "asc"]]+ )- assert json_response(conn, 200)["results"] == [- %{"visitors" => 3, "name" => "/", "percentage" => 50.0},- %{"visitors" => 2, "name" => "/register", "percentage" => 33.33},- %{"visitors" => 1, "name" => "/contact", "percentage" => 16.67},- %{"visitors" => 1, "name" => "/landing", "percentage" => 16.67}+ assert response["results"] == [+ %{"dimensions" => ["/"], "metrics" => [3, 50.0]},+ %{"dimensions" => ["/register"], "metrics" => [2, 33.33]},+ %{"dimensions" => ["/contact"], "metrics" => [1, 16.67]},+ %{"dimensions" => ["/landing"], "metrics" => [1, 16.67]}]- filters = Jason.encode!([[:is, "event:hostname", ["d.example.com"]]])- conn = get(conn1, "/api/stats/#{site.domain}/pages?period=day&filters=#{filters}")+ response =+ query_pages(conn, site,+ date_range: "day",+ filters: [["is", "event:hostname", ["d.example.com"]]]+ )- assert json_response(conn, 200)["results"] == [- %{"visitors" => 2, "name" => "/register", "percentage" => 66.67},- %{"visitors" => 1, "name" => "/", "percentage" => 33.33}+ assert response["results"] == [+ %{"dimensions" => ["/register"], "metrics" => [2, 66.67]},+ %{"dimensions" => ["/"], "metrics" => [1, 33.33]}]end@@ -76,11 +111,14 @@ defmodule PlausibleWeb.Api.StatsController.PagesTest dobuild(:pageview, user_id: 123, pathname: "/")])- filters = Jason.encode!([[:is, "event:props:author", ["John Doe"]]])- conn = get(conn, "/api/stats/#{site.domain}/pages?period=day&filters=#{filters}")+ response =+ query_pages(conn, site,+ date_range: "day",+ filters: [["is", "event:props:author", ["John Doe"]]]+ )- assert json_response(conn, 200)["results"] == [- %{"visitors" => 1, "name" => "/blog/john-1", "percentage" => 100.0}+ assert response["results"] == [+ %{"dimensions" => ["/blog/john-1"], "metrics" => [1, 100.0]}]end@@ -102,12 +140,15 @@ defmodule PlausibleWeb.Api.StatsController.PagesTest dobuild(:pageview, pathname: "/")])- filters = Jason.encode!([[:is_not, "event:props:author", ["John Doe"]]])- conn = get(conn, "/api/stats/#{site.domain}/pages?period=day&filters=#{filters}")+ response =+ query_pages(conn, site,+ date_range: "day",+ filters: [["is_not", "event:props:author", ["John Doe"]]]+ )- assert json_response(conn, 200)["results"] == [- %{"visitors" => 1, "name" => "/", "percentage" => 50.0},- %{"visitors" => 1, "name" => "/blog/other-post", "percentage" => 50.0}+ assert response["results"] == [+ %{"dimensions" => ["/"], "metrics" => [1, 50.0]},+ %{"dimensions" => ["/blog/other-post"], "metrics" => [1, 50.0]}]end@@ -139,12 +180,16 @@ defmodule PlausibleWeb.Api.StatsController.PagesTest dobuild(:pageview, pathname: "/5")])- filters = Jason.encode!([[:contains, "event:props:prop", ["bar"]]])- conn = get(conn, "/api/stats/#{site.domain}/pages?period=day&filters=#{filters}")+ response =+ query_pages(conn, site,+ date_range: "day",+ filters: [["contains", "event:props:prop", ["bar"]]],+ order_by: [["visitors", "desc"], ["event:page", "asc"]]+ )- assert json_response(conn, 200)["results"] == [- %{"visitors" => 1, "name" => "/1", "percentage" => 50.0},- %{"visitors" => 1, "name" => "/2", "percentage" => 50.0}+ assert response["results"] == [+ %{"dimensions" => ["/1"], "metrics" => [1, 50.0]},+ %{"dimensions" => ["/2"], "metrics" => [1, 50.0]}]end@@ -181,13 +226,17 @@ defmodule PlausibleWeb.Api.StatsController.PagesTest do)])- filters = Jason.encode!([[:contains, "event:props:prop", ["bar", "nea"]]])- conn = get(conn, "/api/stats/#{site.domain}/pages?period=day&filters=#{filters}")+ response =+ query_pages(conn, site,+ date_range: "day",+ filters: [["contains", "event:props:prop", ["bar", "nea"]]],+ order_by: [["visitors", "desc"], ["event:page", "asc"]]+ )- assert json_response(conn, 200)["results"] == [- %{"visitors" => 1, "name" => "/1", "percentage" => 33.33},- %{"visitors" => 1, "name" => "/2", "percentage" => 33.33},- %{"visitors" => 1, "name" => "/6", "percentage" => 33.33}+ assert response["results"] == [+ %{"dimensions" => ["/1"], "metrics" => [1, 33.33]},+ %{"dimensions" => ["/2"], "metrics" => [1, 33.33]},+ %{"dimensions" => ["/6"], "metrics" => [1, 33.33]}]end@@ -219,16 +268,17 @@ defmodule PlausibleWeb.Api.StatsController.PagesTest dobuild(:pageview, pathname: "/5")])- filters =- Jason.encode!([- [:is, "event:props:prop", ["bar"]],- [:is, "event:props:number", ["1"]]- ])-- conn = get(conn, "/api/stats/#{site.domain}/pages?period=day&filters=#{filters}")+ response =+ query_pages(conn, site,+ date_range: "day",+ filters: [+ ["is", "event:props:prop", ["bar"]],+ ["is", "event:props:number", ["1"]]+ ]+ )- assert json_response(conn, 200)["results"] == [- %{"visitors" => 1, "name" => "/1", "percentage" => 100.0}+ assert response["results"] == [+ %{"dimensions" => ["/1"], "metrics" => [1, 100.0]}]end@@ -304,33 +354,16 @@ defmodule PlausibleWeb.Api.StatsController.PagesTest do)])- filters = Jason.encode!([[:is, "event:props:author", ["John Doe"]]])-- conn =- get(- conn,- "/api/stats/#{site.domain}/pages?period=day&date=2021-01-01&filters=#{filters}&detailed=true"+ response =+ query_pages(conn, site,+ date_range: ["2021-01-01", "2021-01-01"],+ filters: [["is", "event:props:author", ["John Doe"]]],+ metrics: @detailed_metrics)- assert json_response(conn, 200)["results"] == [- %{- "name" => "/blog/john-2",- "visitors" => 2,- "pageviews" => 2,- "bounce_rate" => 0,- "time_on_page" => 315,- "scroll_depth" => 0,- "percentage" => 100.0- },- %{- "name" => "/blog/john-1",- "visitors" => 1,- "pageviews" => 1,- "bounce_rate" => 0,- "time_on_page" => 60,- "scroll_depth" => 0,- "percentage" => 50.0- }+ assert response["results"] == [+ %{"dimensions" => ["/blog/john-2"], "metrics" => [2, 2, 0, 315, 0, 100.0]},+ %{"dimensions" => ["/blog/john-1"], "metrics" => [1, 1, 0, 60, 0, 50.0]}]end@@ -406,33 +439,16 @@ defmodule PlausibleWeb.Api.StatsController.PagesTest do)])- filters = Jason.encode!([[:is_not, "event:props:author", ["John Doe"]]])-- conn =- get(- conn,- "/api/stats/#{site.domain}/pages?period=day&date=2021-01-01&filters=#{filters}&detailed=true"+ response =+ query_pages(conn, site,+ date_range: ["2021-01-01", "2021-01-01"],+ filters: [["is_not", "event:props:author", ["John Doe"]]],+ metrics: @detailed_metrics)- assert json_response(conn, 200)["results"] == [- %{- "name" => "/blog",- "visitors" => 2,- "pageviews" => 2,- "bounce_rate" => 0,- "time_on_page" => 120,- "scroll_depth" => 0,- "percentage" => 100.0- },- %{- "name" => "/blog/other-post",- "visitors" => 1,- "pageviews" => 1,- "bounce_rate" => 0,- "time_on_page" => 30,- "scroll_depth" => 0,- "percentage" => 50.0- }+ assert response["results"] == [+ %{"dimensions" => ["/blog"], "metrics" => [2, 2, 0, 120, 0, 100.0]},+ %{"dimensions" => ["/blog/other-post"], "metrics" => [1, 1, 0, 30, 0, 50.0]}]end@@ -489,33 +505,16 @@ defmodule PlausibleWeb.Api.StatsController.PagesTest do)])- filters = Jason.encode!([[:is, "event:props:author", ["(none)"]]])-- conn =- get(- conn,- "/api/stats/#{site.domain}/pages?period=day&date=2021-01-01&filters=#{filters}&detailed=true"+ response =+ query_pages(conn, site,+ date_range: ["2021-01-01", "2021-01-01"],+ filters: [["is", "event:props:author", ["(none)"]]],+ metrics: @detailed_metrics)- assert json_response(conn, 200)["results"] == [- %{- "name" => "/blog",- "visitors" => 2,- "pageviews" => 2,- "bounce_rate" => 50,- "time_on_page" => 45,- "scroll_depth" => 0,- "percentage" => 100.0- },- %{- "name" => "/blog/other-post",- "visitors" => 1,- "pageviews" => 1,- "bounce_rate" => 0,- "time_on_page" => 30,- "scroll_depth" => 0,- "percentage" => 50.0- }+ assert response["results"] == [+ %{"dimensions" => ["/blog"], "metrics" => [2, 2, 50, 45, 0, 100.0]},+ %{"dimensions" => ["/blog/other-post"], "metrics" => [1, 1, 0, 30, 0, 50.0]}]end@@ -580,33 +579,16 @@ defmodule PlausibleWeb.Api.StatsController.PagesTest do)])- filters = Jason.encode!([[:is_not, "event:props:author", ["(none)"]]])-- conn =- get(- conn,- "/api/stats/#{site.domain}/pages?period=day&date=2021-01-01&filters=#{filters}&detailed=true"+ response =+ query_pages(conn, site,+ date_range: ["2021-01-01", "2021-01-01"],+ filters: [["is_not", "event:props:author", ["(none)"]]],+ metrics: @detailed_metrics)- assert json_response(conn, 200)["results"] == [- %{- "name" => "/blog/other-post",- "visitors" => 2,- "pageviews" => 2,- "bounce_rate" => 100,- "time_on_page" => 30,- "scroll_depth" => 0,- "percentage" => 100.0- },- %{- "name" => "/blog/john-1",- "visitors" => 1,- "pageviews" => 1,- "bounce_rate" => 0,- "time_on_page" => 60,- "scroll_depth" => 0,- "percentage" => 50.0- }+ assert response["results"] == [+ %{"dimensions" => ["/blog/other-post"], "metrics" => [2, 2, 100, 30, 0, 100.0]},+ %{"dimensions" => ["/blog/john-1"], "metrics" => [1, 1, 0, 60, 0, 50.0]}]end@@ -645,20 +627,19 @@ defmodule PlausibleWeb.Api.StatsController.PagesTest do)])- filters = Jason.encode!([[:is_not, "event:props:browser", ["Chrome", "Safari"]]])-- conn =- get(conn, "/api/stats/#{site.domain}/pages?period=day&date=2021-01-01&filters=#{filters}")+ response =+ query_pages(conn, site,+ date_range: ["2021-01-01", "2021-01-01"],+ filters: [["is_not", "event:props:browser", ["Chrome", "Safari"]]]+ )- assert json_response(conn, 200)["results"] == [- %{- "name" => "/firefox",- "visitors" => 2,- "percentage" => 100.0- }+ assert response["results"] == [+ %{"dimensions" => ["/firefox"], "metrics" => [2, 100.0]}]- assert json_response(conn, 200)["meta"] == %{"date_range_label" => "1 Jan 2021"}+ assert %{+ "date_range" => ["2021-01-01T00:00:00Z", "2021-01-01T23:59:59Z"]+ } = response["query"]endtest "returns top pages with :not_member filter on custom pageview props including (none) value",@@ -688,17 +669,14 @@ defmodule PlausibleWeb.Api.StatsController.PagesTest do)])- filters = Jason.encode!([[:is_not, "event:props:browser", ["Chrome", "(none)"]]])-- conn =- get(conn, "/api/stats/#{site.domain}/pages?period=day&date=2021-01-01&filters=#{filters}")+ response =+ query_pages(conn, site,+ date_range: ["2021-01-01", "2021-01-01"],+ filters: [["is_not", "event:props:browser", ["Chrome", "(none)"]]]+ )- assert json_response(conn, 200)["results"] == [- %{- "name" => "/safari",- "visitors" => 1,- "percentage" => 100.0- }+ assert response["results"] == [+ %{"dimensions" => ["/safari"], "metrics" => [1, 100.0]}]end@@ -755,24 +733,15 @@ defmodule PlausibleWeb.Api.StatsController.PagesTest do)])- filters = Jason.encode!([[:is, "event:page", ["/"]]])-- conn =- get(- conn,- "/api/stats/#{site.domain}/pages?period=day&date=2021-01-01&filters=#{filters}&detailed=true"+ response =+ query_pages(conn, site,+ date_range: ["2021-01-01", "2021-01-01"],+ filters: [["is", "event:page", ["/"]]],+ metrics: @detailed_metrics)- assert json_response(conn, 200)["results"] == [- %{- "name" => "/",- "visitors" => 2,- "pageviews" => 3,- "bounce_rate" => 50,- "time_on_page" => 90,- "scroll_depth" => 0,- "percentage" => 100.0- }+ assert response["results"] == [+ %{"dimensions" => ["/"], "metrics" => [2, 3, 50, 90, 0, 100.0]}]end@@ -831,31 +800,16 @@ defmodule PlausibleWeb.Api.StatsController.PagesTest do)])- conn =- get(- conn,- "/api/stats/#{site.domain}/pages?period=day&date=2020-01-01&detailed=true&order_by=#{Jason.encode!([["scroll_depth", "asc"]])}"+ response =+ query_pages(conn, site,+ date_range: ["2020-01-01", "2020-01-01"],+ metrics: @detailed_metrics,+ order_by: [["scroll_depth", "asc"]])- assert json_response(conn, 200)["results"] == [- %{- "name" => "/another",- "visitors" => 2,- "pageviews" => 2,- "bounce_rate" => 0,- "time_on_page" => 60,- "scroll_depth" => 25,- "percentage" => 66.67- },- %{- "name" => "/blog",- "visitors" => 3,- "pageviews" => 4,- "bounce_rate" => 33,- "time_on_page" => 80,- "scroll_depth" => 60,- "percentage" => 100.0- }+ assert response["results"] == [+ %{"dimensions" => ["/another"], "metrics" => [2, 2, 0, 60, 25, 66.67]},+ %{"dimensions" => ["/blog"], "metrics" => [3, 4, 33, 80, 60, 100.0]}]end@@ -895,22 +849,16 @@ defmodule PlausibleWeb.Api.StatsController.PagesTest dobuild(:imported_visitors, date: ~D[2020-01-01])])- conn =- get(- conn,- "/api/stats/#{site.domain}/pages?period=day&date=2020-01-01&detailed=true&with_imported=true&order_by=#{Jason.encode!([["scroll_depth", "desc"]])}"+ response =+ query_pages(conn, site,+ date_range: ["2020-01-01", "2020-01-01"],+ metrics: @detailed_metrics,+ include: %{"imports" => true},+ order_by: [["scroll_depth", "desc"]])- assert json_response(conn, 200)["results"] == [- %{- "name" => "/blog",- "visitors" => 4,- "pageviews" => 4,- "bounce_rate" => 100,- "time_on_page" => 28,- "scroll_depth" => 50,- "percentage" => 100.0- }+ assert response["results"] == [+ %{"dimensions" => ["/blog"], "metrics" => [4, 4, 100, 28, 50, 100.0]}]end@@ -972,40 +920,18 @@ defmodule PlausibleWeb.Api.StatsController.PagesTest dofor(_ <- 1..24, do: build(:imported_visitors, date: ~D[2020-01-01])))- conn =- get(- conn,- "/api/stats/#{site.domain}/pages?period=day&date=2020-01-01&detailed=true&with_imported=true&order_by=#{Jason.encode!([["scroll_depth", "desc"]])}"+ response =+ query_pages(conn, site,+ date_range: ["2020-01-01", "2020-01-01"],+ metrics: @detailed_metrics,+ include: %{"imports" => true},+ order_by: [["scroll_depth", "desc"]])- assert json_response(conn, 200)["results"] == [- %{- "name" => "/native-and-imported",- "visitors" => 5,- "pageviews" => 5,- "bounce_rate" => 0,- "time_on_page" => 48,- "scroll_depth" => 50,- "percentage" => 20.0- },- %{- "name" => "/native-only",- "visitors" => 1,- "pageviews" => 1,- "bounce_rate" => 0,- "time_on_page" => 60,- "scroll_depth" => 40,- "percentage" => 4.0- },- %{- "name" => "/imported-only",- "visitors" => 20,- "pageviews" => 30,- "bounce_rate" => 0,- "time_on_page" => 30,- "scroll_depth" => 10,- "percentage" => 80.0- }+ assert response["results"] == [+ %{"dimensions" => ["/native-and-imported"], "metrics" => [5, 5, 0, 48, 50, 20.0]},+ %{"dimensions" => ["/native-only"], "metrics" => [1, 1, 0, 60, 40, 4.0]},+ %{"dimensions" => ["/imported-only"], "metrics" => [20, 30, 0, 30, 10, 80.0]}]end@@ -1037,22 +963,16 @@ defmodule PlausibleWeb.Api.StatsController.PagesTest do)])- conn =- get(- conn,- "/api/stats/#{site.domain}/pages?period=7d&date=2020-01-02&detailed=true&with_imported=true"+ response =+ query_pages(conn, site,+ date_range: "7d",+ relative_date: "2020-01-02",+ metrics: @detailed_metrics,+ include: %{"imports" => true})- assert json_response(conn, 200)["results"] == [- %{- "name" => "/blog",- "visitors" => 110,- "pageviews" => 160,- "bounce_rate" => 0,- "time_on_page" => 60,- "scroll_depth" => 10,- "percentage" => nil- }+ assert response["results"] == [+ %{"dimensions" => ["/blog"], "metrics" => [110, 160, 0, 60, 10, nil]}]end@@ -1116,33 +1036,16 @@ defmodule PlausibleWeb.Api.StatsController.PagesTest do)])- filters = Jason.encode!([[:is, "event:page", ["/", "/about"]]])-- conn =- get(- conn,- "/api/stats/#{site.domain}/pages?period=day&date=2021-01-01&filters=#{filters}&detailed=true"+ response =+ query_pages(conn, site,+ date_range: ["2021-01-01", "2021-01-01"],+ filters: [["is", "event:page", ["/", "/about"]]],+ metrics: @detailed_metrics)- assert json_response(conn, 200)["results"] == [- %{- "name" => "/",- "visitors" => 2,- "pageviews" => 3,- "bounce_rate" => 50,- "time_on_page" => 75,- "scroll_depth" => 0,- "percentage" => 66.67- },- %{- "name" => "/about",- "visitors" => 1,- "pageviews" => 1,- "bounce_rate" => 100,- "time_on_page" => 30,- "scroll_depth" => 0,- "percentage" => 33.33- }+ assert response["results"] == [+ %{"dimensions" => ["/"], "metrics" => [2, 3, 50, 75, 0, 66.67]},+ %{"dimensions" => ["/about"], "metrics" => [1, 1, 100, 30, 0, 33.33]}]end@@ -1206,24 +1109,15 @@ defmodule PlausibleWeb.Api.StatsController.PagesTest do)])- filters = Jason.encode!([[:is_not, "event:page", ["/irrelevant", "/about"]]])-- conn =- get(- conn,- "/api/stats/#{site.domain}/pages?period=day&date=2021-01-01&filters=#{filters}&detailed=true"+ response =+ query_pages(conn, site,+ date_range: ["2021-01-01", "2021-01-01"],+ filters: [["is_not", "event:page", ["/irrelevant", "/about"]]],+ metrics: @detailed_metrics)- assert json_response(conn, 200)["results"] == [- %{- "name" => "/",- "visitors" => 2,- "pageviews" => 3,- "bounce_rate" => 50,- "time_on_page" => 75,- "scroll_depth" => 0,- "percentage" => 100.0- }+ assert response["results"] == [+ %{"dimensions" => ["/"], "metrics" => [2, 3, 50, 75, 0, 100.0]}]end@@ -1287,42 +1181,18 @@ defmodule PlausibleWeb.Api.StatsController.PagesTest do)])- filters = Jason.encode!([[:contains, "event:page", ["/blog/", "/articles/"]]])-- conn =- get(- conn,- "/api/stats/#{site.domain}/pages?period=day&date=2021-01-01&filters=#{filters}&detailed=true"+ response =+ query_pages(conn, site,+ date_range: ["2021-01-01", "2021-01-01"],+ filters: [["contains", "event:page", ["/blog/", "/articles/"]]],+ metrics: @detailed_metrics,+ order_by: [["visitors", "desc"], ["event:page", "asc"]])- assert json_response(conn, 200)["results"] == [- %{- "name" => "/articles/post-1",- "visitors" => 2,- "pageviews" => 2,- "bounce_rate" => 100,- "time_on_page" => 30,- "scroll_depth" => 0,- "percentage" => 66.67- },- %{- "name" => "/blog/post-1",- "visitors" => 1,- "pageviews" => 1,- "bounce_rate" => 0,- "time_on_page" => 60,- "scroll_depth" => 0,- "percentage" => 33.33- },- %{- "name" => "/blog/post-2",- "visitors" => 1,- "pageviews" => 1,- "bounce_rate" => 0,- "time_on_page" => 30,- "scroll_depth" => 0,- "percentage" => 33.33- }+ assert response["results"] == [+ %{"dimensions" => ["/articles/post-1"], "metrics" => [2, 2, 100, 30, 0, 66.67]},+ %{"dimensions" => ["/blog/post-1"], "metrics" => [1, 1, 0, 60, 0, 33.33]},+ %{"dimensions" => ["/blog/post-2"], "metrics" => [1, 1, 0, 30, 0, 33.33]}]end@@ -1364,33 +1234,17 @@ defmodule PlausibleWeb.Api.StatsController.PagesTest do)])- filters = Jason.encode!([[:contains, "event:page", ["/blog/(/", "/blog/)/"]]])-- conn =- get(- conn,- "/api/stats/#{site.domain}/pages?period=day&date=2021-01-01&filters=#{filters}&detailed=true"+ response =+ query_pages(conn, site,+ date_range: ["2021-01-01", "2021-01-01"],+ filters: [["contains", "event:page", ["/blog/(/", "/blog/)/"]]],+ order_by: [["visitors", "desc"], ["event:page", "asc"]],+ metrics: @detailed_metrics)- assert json_response(conn, 200)["results"] == [- %{- "name" => "/blog/(/post-1",- "visitors" => 1,- "pageviews" => 1,- "bounce_rate" => 0,- "time_on_page" => 60,- "scroll_depth" => 0,- "percentage" => 100.0- },- %{- "name" => "/blog/(/post-2",- "visitors" => 1,- "pageviews" => 1,- "bounce_rate" => 0,- "time_on_page" => 30,- "scroll_depth" => 0,- "percentage" => 100.0- }+ assert response["results"] == [+ %{"dimensions" => ["/blog/(/post-1"], "metrics" => [1, 1, 0, 60, 0, 100.0]},+ %{"dimensions" => ["/blog/(/post-2"], "metrics" => [1, 1, 0, 30, 0, 100.0]}]end@@ -1454,33 +1308,16 @@ defmodule PlausibleWeb.Api.StatsController.PagesTest do)])- filters = Jason.encode!([[:contains_not, "event:page", ["/blog/", "/articles/"]]])-- conn =- get(- conn,- "/api/stats/#{site.domain}/pages?period=day&date=2021-01-01&filters=#{filters}&detailed=true"+ response =+ query_pages(conn, site,+ date_range: ["2021-01-01", "2021-01-01"],+ filters: [["contains_not", "event:page", ["/blog/", "/articles/"]]],+ metrics: @detailed_metrics)- assert json_response(conn, 200)["results"] == [- %{- "name" => "/",- "visitors" => 2,- "pageviews" => 2,- "bounce_rate" => 50,- "time_on_page" => 600,- "scroll_depth" => 0,- "percentage" => 100.0- },- %{- "name" => "/about",- "visitors" => 1,- "pageviews" => 1,- "bounce_rate" => 0,- "time_on_page" => 30,- "scroll_depth" => 0,- "percentage" => 50.0- }+ assert response["results"] == [+ %{"dimensions" => ["/"], "metrics" => [2, 2, 50, 600, 0, 100.0]},+ %{"dimensions" => ["/about"], "metrics" => [1, 1, 0, 30, 0, 50.0]}]end@@ -1496,28 +1333,30 @@ defmodule PlausibleWeb.Api.StatsController.PagesTest dobuild(:pageview, pathname: "/contact")])- conn1 = get(conn, "/api/stats/#{site.domain}/pages?period=day")+ response = query_pages(conn, site, date_range: "day")- assert json_response(conn1, 200)["results"] == [- %{"visitors" => 3, "name" => "/", "percentage" => 50.0},- %{"visitors" => 2, "name" => "/register", "percentage" => 33.33},- %{"visitors" => 1, "name" => "/contact", "percentage" => 16.67}+ assert response["results"] == [+ %{"dimensions" => ["/"], "metrics" => [3, 50.0]},+ %{"dimensions" => ["/register"], "metrics" => [2, 33.33]},+ %{"dimensions" => ["/contact"], "metrics" => [1, 16.67]}]- conn2 = get(conn, "/api/stats/#{site.domain}/pages?period=day&with_imported=true")+ response = query_pages(conn, site, date_range: "day", include: %{"imports" => true})- assert json_response(conn2, 200)["results"] == [- %{"visitors" => 4, "name" => "/", "percentage" => 66.67},- %{"visitors" => 3, "name" => "/register", "percentage" => 50.0},- %{"visitors" => 1, "name" => "/contact", "percentage" => 16.67}+ assert response["results"] == [+ %{"dimensions" => ["/"], "metrics" => [4, 66.67]},+ %{"dimensions" => ["/register"], "metrics" => [3, 50.0]},+ %{"dimensions" => ["/contact"], "metrics" => [1, 16.67]}]endtest "returns scroll depth warning code", %{conn: conn, site: site} do- conn =- get(conn, "/api/stats/#{site.domain}/pages?period=day&detailed=true&with_imported=true")-- response = json_response(conn, 200)+ response =+ query_pages(conn, site,+ date_range: "day",+ metrics: @detailed_metrics,+ include: %{"imports" => true}+ )assert response["meta"]["metric_warnings"]["scroll_depth"]["code"] =="no_imported_scroll_depth"@@ -1533,23 +1372,17 @@ defmodule PlausibleWeb.Api.StatsController.PagesTest dobuild(:imported_visitors, visitors: 4)])- filters = Jason.encode!([[:is, "event:goal", ["Visit /blog**"]]])- q = "?period=day&filters=#{filters}&with_imported=true"- conn = get(conn, "/api/stats/#{site.domain}/pages#{q}")+ response =+ query_pages(conn, site,+ date_range: "day",+ filters: [["is", "event:goal", ["Visit /blog**"]]],+ metrics: @goal_filter_metrics,+ include: %{"imports" => true}+ )- assert json_response(conn, 200)["results"] == [- %{- "visitors" => 2,- "name" => "/blog/post-1",- "conversion_rate" => 100.0,- "total_visitors" => 2- },- %{- "visitors" => 1,- "name" => "/blog",- "conversion_rate" => 100.0,- "total_visitors" => 1- }+ assert response["results"] == [+ %{"dimensions" => ["/blog/post-1"], "metrics" => [2, 100.0, 2]},+ %{"dimensions" => ["/blog"], "metrics" => [1, 100.0, 1]}]end@@ -1590,31 +1423,15 @@ defmodule PlausibleWeb.Api.StatsController.PagesTest do)])- conn =- get(- conn,- "/api/stats/#{site.domain}/pages?period=day&date=2021-01-01&detailed=true"+ response =+ query_pages(conn, site,+ date_range: ["2021-01-01", "2021-01-01"],+ metrics: @detailed_metrics)- assert json_response(conn, 200)["results"] == [- %{- "bounce_rate" => 50.0,- "time_on_page" => 465.0,- "visitors" => 2,- "pageviews" => 2,- "name" => "/",- "scroll_depth" => 0,- "percentage" => 100.0- },- %{- "bounce_rate" => 0,- "time_on_page" => 30,- "visitors" => 1,- "pageviews" => 1,- "name" => "/some-other-page",- "scroll_depth" => 0,- "percentage" => 50.0- }+ assert response["results"] == [+ %{"dimensions" => ["/"], "metrics" => [2, 2, 50.0, 465.0, 0, 100.0]},+ %{"dimensions" => ["/some-other-page"], "metrics" => [1, 1, 0, 30, 0, 50.0]}]end@@ -1639,24 +1456,15 @@ defmodule PlausibleWeb.Api.StatsController.PagesTest do)])- filters = Jason.encode!([[:is, "event:hostname", ["blog.example.com"]]])-- conn =- get(- conn,- "/api/stats/#{site.domain}/pages?period=day&date=2021-01-01&detailed=true&filters=#{filters}"+ response =+ query_pages(conn, site,+ date_range: ["2021-01-01", "2021-01-01"],+ filters: [["is", "event:hostname", ["blog.example.com"]]],+ metrics: @detailed_metrics)- assert json_response(conn, 200)["results"] == [- %{- "bounce_rate" => 50,- "name" => "/about",- "pageviews" => 2,- "time_on_page" => nil,- "visitors" => 2,- "scroll_depth" => nil,- "percentage" => 100.0- }+ assert response["results"] == [+ %{"dimensions" => ["/about"], "metrics" => [2, 2, 50, nil, nil, 100.0]}]end@@ -1776,33 +1584,16 @@ defmodule PlausibleWeb.Api.StatsController.PagesTest do)])- filters = Jason.encode!([[:is, "event:hostname", ["blog.example.com"]]])-- conn =- get(- conn,- "/api/stats/#{site.domain}/pages?period=day&date=2021-01-01&detailed=true&filters=#{filters}"+ response =+ query_pages(conn, site,+ date_range: ["2021-01-01", "2021-01-01"],+ filters: [["is", "event:hostname", ["blog.example.com"]]],+ metrics: @detailed_metrics)- assert json_response(conn, 200)["results"] == [- %{- "bounce_rate" => 50,- "name" => "/about-blog",- "pageviews" => 3,- "time_on_page" => 435,- "visitors" => 2,- "scroll_depth" => 0,- "percentage" => 100.0- },- %{- "bounce_rate" => 0,- "name" => "/exit-blog",- "pageviews" => 1,- "time_on_page" => 120,- "visitors" => 1,- "scroll_depth" => 0,- "percentage" => 50.0- }+ assert response["results"] == [+ %{"dimensions" => ["/about-blog"], "metrics" => [2, 3, 50, 435, 0, 100.0]},+ %{"dimensions" => ["/exit-blog"], "metrics" => [1, 1, 0, 120, 0, 50.0]}]end@@ -1871,31 +1662,16 @@ defmodule PlausibleWeb.Api.StatsController.PagesTest dobuild(:imported_visitors, date: ~D[2021-01-01])])- conn =- get(- conn,- "/api/stats/#{site.domain}/pages?period=day&date=2021-01-01&detailed=true&with_imported=true"+ response =+ query_pages(conn, site,+ date_range: ["2021-01-01", "2021-01-01"],+ metrics: @detailed_metrics,+ include: %{"imports" => true})- assert json_response(conn, 200)["results"] == [- %{- "bounce_rate" => 40.0,- "time_on_page" => 500,- "visitors" => 3,- "pageviews" => 3,- "scroll_depth" => 0,- "name" => "/",- "percentage" => 60.0- },- %{- "bounce_rate" => 0,- "time_on_page" => 45,- "visitors" => 2,- "pageviews" => 2,- "scroll_depth" => 0,- "name" => "/some-other-page",- "percentage" => 40.0- }+ assert response["results"] == [+ %{"dimensions" => ["/"], "metrics" => [3, 3, 40.0, 500, 0, 60.0]},+ %{"dimensions" => ["/some-other-page"], "metrics" => [2, 2, 0, 45, 0, 40.0]}]end@@ -1906,11 +1682,11 @@ defmodule PlausibleWeb.Api.StatsController.PagesTest dobuild(:pageview, pathname: "/page1")])- conn = get(conn, "/api/stats/#{site.domain}/pages?period=realtime")+ response = query_pages(conn, site, date_range: "realtime")- assert json_response(conn, 200)["results"] == [- %{"visitors" => 2, "name" => "/page1", "percentage" => 66.67},- %{"visitors" => 1, "name" => "/page2", "percentage" => 33.33}+ assert response["results"] == [+ %{"dimensions" => ["/page1"], "metrics" => [2, 66.67]},+ %{"dimensions" => ["/page2"], "metrics" => [1, 33.33]}]end@@ -1923,17 +1699,16 @@ defmodule PlausibleWeb.Api.StatsController.PagesTest do])insert(:goal, site: site, event_name: "Signup")- filters = Jason.encode!([[:is, "event:goal", ["Signup"]]])- conn = get(conn, "/api/stats/#{site.domain}/pages?period=day&filters=#{filters}")+ response =+ query_pages(conn, site,+ date_range: "day",+ filters: [["is", "event:goal", ["Signup"]]],+ metrics: @goal_filter_metrics+ )- assert json_response(conn, 200)["results"] == [- %{- "total_visitors" => 3,- "visitors" => 1,- "name" => "/",- "conversion_rate" => 33.33- }+ assert response["results"] == [+ %{"dimensions" => ["/"], "metrics" => [1, 33.33, 3]}]end@@ -1972,21 +1747,16 @@ defmodule PlausibleWeb.Api.StatsController.PagesTest dobuild(:imported_pages, page: "/ignored", visitors: 10, date: ~D[2021-01-01])])- filters = Jason.encode!([[:is, "event:page", ["/"]]])- q = "?period=day&date=2021-01-01&filters=#{filters}&detailed=true&with_imported=true"-- conn = get(conn, "/api/stats/#{site.domain}/pages#{q}")+ response =+ query_pages(conn, site,+ date_range: ["2021-01-01", "2021-01-01"],+ filters: [["is", "event:page", ["/"]]],+ metrics: @detailed_metrics,+ include: %{"imports" => true}+ )- assert json_response(conn, 200)["results"] == [- %{- "bounce_rate" => 50,- "name" => "/",- "pageviews" => 4,- "time_on_page" => 90.0,- "visitors" => 4,- "scroll_depth" => 0,- "percentage" => 100.0- }+ assert response["results"] == [+ %{"dimensions" => ["/"], "metrics" => [4, 4, 50, 90.0, 0, 100.0]}]end@@ -2036,30 +1806,17 @@ defmodule PlausibleWeb.Api.StatsController.PagesTest dobuild(:imported_pages, page: "/ignored", visitors: 10, date: ~D[2021-01-01])])- filters = Jason.encode!([[:is, "event:page", ["/", "/a"]]])- q = "?period=day&date=2021-01-01&filters=#{filters}&detailed=true&with_imported=true"-- conn = get(conn, "/api/stats/#{site.domain}/pages#{q}")+ response =+ query_pages(conn, site,+ date_range: ["2021-01-01", "2021-01-01"],+ filters: [["is", "event:page", ["/", "/a"]]],+ metrics: @detailed_metrics,+ include: %{"imports" => true}+ )- assert json_response(conn, 200)["results"] == [- %{- "bounce_rate" => 50,- "name" => "/",- "pageviews" => 4,- "time_on_page" => 90.0,- "visitors" => 4,- "scroll_depth" => 0,- "percentage" => 80.0- },- %{- "bounce_rate" => 100,- "name" => "/a",- "pageviews" => 1,- "time_on_page" => 10.0,- "visitors" => 1,- "scroll_depth" => nil,- "percentage" => 20.0- }+ assert response["results"] == [+ %{"dimensions" => ["/"], "metrics" => [4, 4, 50, 90.0, 0, 80.0]},+ %{"dimensions" => ["/a"], "metrics" => [1, 1, 100, 10.0, nil, 20.0]}]end@@ -2109,30 +1866,17 @@ defmodule PlausibleWeb.Api.StatsController.PagesTest dobuild(:imported_pages, page: "/ignored", visitors: 10, date: ~D[2021-01-01])])- filters = Jason.encode!([[:contains, "event:page", ["/a"]]])- q = "?period=day&date=2021-01-01&filters=#{filters}&detailed=true&with_imported=true"-- conn = get(conn, "/api/stats/#{site.domain}/pages#{q}")+ response =+ query_pages(conn, site,+ date_range: ["2021-01-01", "2021-01-01"],+ filters: [["contains", "event:page", ["/a"]]],+ metrics: @detailed_metrics,+ include: %{"imports" => true}+ )- assert json_response(conn, 200)["results"] == [- %{- "bounce_rate" => 50.0,- "name" => "/aaa",- "pageviews" => 4,- "time_on_page" => 90,- "visitors" => 4,- "scroll_depth" => 0,- "percentage" => 80.0- },- %{- "bounce_rate" => 100.0,- "name" => "/a",- "pageviews" => 1,- "time_on_page" => 10,- "visitors" => 1,- "scroll_depth" => nil,- "percentage" => 20.0- }+ assert response["results"] == [+ %{"dimensions" => ["/aaa"], "metrics" => [4, 4, 50.0, 90, 0, 80.0]},+ %{"dimensions" => ["/a"], "metrics" => [1, 1, 100.0, 10, nil, 20.0]}]end@@ -2156,69 +1900,38 @@ defmodule PlausibleWeb.Api.StatsController.PagesTest do)])- conn =- get(- conn,- "/api/stats/#{site.domain}/pages?period=day&date=2021-01-02&comparison=previous_period&detailed=true"+ response =+ query_pages(conn, site,+ date_range: ["2021-01-02", "2021-01-02"],+ metrics: @detailed_metrics,+ include: %{"compare" => "previous_period"})- assert json_response(conn, 200)["results"] == [+ assert response["results"] == [%{- "bounce_rate" => 100,+ "dimensions" => ["/page2"],+ "metrics" => [2, 2, 100, nil, nil, 66.67],"comparison" => %{- "bounce_rate" => 0.0,- "pageviews" => 0,- "time_on_page" => nil,- "visitors" => 0,- "scroll_depth" => nil,- "percentage" => 0.0,- "change" => %{- "bounce_rate" => nil,- "pageviews" => 100,- "time_on_page" => nil,- "visitors" => 100,- "scroll_depth" => nil,- "percentage" => 100- }- },- "name" => "/page2",- "pageviews" => 2,- "time_on_page" => nil,- "visitors" => 2,- "scroll_depth" => nil,- "percentage" => 66.67+ "dimensions" => ["/page2"],+ "metrics" => [0, 0, 0.0, nil, nil, 0.0],+ "change" => [100, 100, nil, nil, nil, 100]+ }},%{- "bounce_rate" => 100,- "name" => "/page1",- "pageviews" => 1,- "time_on_page" => nil,- "visitors" => 1,- "scroll_depth" => nil,- "percentage" => 33.33,+ "dimensions" => ["/page1"],+ "metrics" => [1, 1, 100, nil, nil, 33.33],"comparison" => %{- "bounce_rate" => 100,- "pageviews" => 1,- "time_on_page" => nil,- "visitors" => 1,- "scroll_depth" => nil,- "percentage" => 100.0,- "change" => %{- "bounce_rate" => 0,- "pageviews" => 0,- "time_on_page" => nil,- "visitors" => 0,- "scroll_depth" => nil,- "percentage" => -67- }+ "dimensions" => ["/page1"],+ "metrics" => [1, 1, 100, nil, nil, 100.0],+ "change" => [0, 0, 0, nil, nil, -67]}}]- assert json_response(conn, 200)["meta"] == %{- "date_range_label" => "2 Jan 2021",- "comparison_date_range_label" => "1 Jan 2021"- }+ assert %{+ "comparison_date_range" => ["2021-01-01T00:00:00Z", "2021-01-01T23:59:59Z"],+ "date_range" => ["2021-01-02T00:00:00Z", "2021-01-02T23:59:59Z"]+ } = response["query"]endon_ee do@@ -2238,40 +1951,16 @@ defmodule PlausibleWeb.Api.StatsController.PagesTest dobuild(:pageview, pathname: "/b1", timestamp: ~N[2021-01-01 00:00:00])])- conn =- get(- conn,- "/api/stats/#{cv.domain}/pages?period=day&date=2021-01-01&detailed=true"+ response =+ query_pages(conn, cv,+ date_range: ["2021-01-01", "2021-01-01"],+ metrics: @detailed_metrics)- assert json_response(conn, 200)["results"] == [- %{- "bounce_rate" => 100,- "name" => "/b1",- "pageviews" => 3,- "time_on_page" => nil,- "visitors" => 3,- "scroll_depth" => nil,- "percentage" => 50.0- },- %{- "bounce_rate" => 100,- "name" => "/a2",- "pageviews" => 2,- "time_on_page" => nil,- "visitors" => 2,- "scroll_depth" => nil,- "percentage" => 33.33- },- %{- "bounce_rate" => 100,- "name" => "/a1",- "pageviews" => 1,- "time_on_page" => nil,- "visitors" => 1,- "scroll_depth" => nil,- "percentage" => 16.67- }+ assert response["results"] == [+ %{"dimensions" => ["/b1"], "metrics" => [3, 3, 100, nil, nil, 50.0]},+ %{"dimensions" => ["/a2"], "metrics" => [2, 2, 100, nil, nil, 33.33]},+ %{"dimensions" => ["/a1"], "metrics" => [1, 1, 100, nil, nil, 16.67]}]endend@@ -2310,25 +1999,16 @@ defmodule PlausibleWeb.Api.StatsController.PagesTest do)])- conn = get(conn, "/api/stats/#{site.domain}/entry-pages?period=day&date=2021-01-01")+ response =+ query_pages(conn, site,+ date_range: ["2021-01-01", "2021-01-01"],+ dimensions: ["visit:entry_page"],+ metrics: ["visitors", "visits", "bounce_rate", "visit_duration", "percentage"]+ )- assert json_response(conn, 200)["results"] == [- %{- "visitors" => 2,- "visits" => 2,- "name" => "/page1",- "visit_duration" => 0,- "bounce_rate" => 100,- "percentage" => 66.67- },- %{- "visitors" => 1,- "visits" => 2,- "name" => "/page2",- "visit_duration" => 450,- "bounce_rate" => 50,- "percentage" => 33.33- }+ assert response["results"] == [+ %{"dimensions" => ["/page1"], "metrics" => [2, 2, 100, 0, 66.67]},+ %{"dimensions" => ["/page2"], "metrics" => [1, 2, 50, 450, 33.33]}]end@@ -2364,31 +2044,17 @@ defmodule PlausibleWeb.Api.StatsController.PagesTest do)])- filters = Jason.encode!([[:is, "event:props:author", ["John Doe"]]])-- conn =- get(- conn,- "/api/stats/#{site.domain}/entry-pages?period=day&date=2021-01-01&filters=#{filters}"+ response =+ query_pages(conn, site,+ date_range: ["2021-01-01", "2021-01-01"],+ dimensions: ["visit:entry_page"],+ filters: [["is", "event:props:author", ["John Doe"]]],+ metrics: ["visitors", "visits", "bounce_rate", "visit_duration", "percentage"])- assert json_response(conn, 200)["results"] == [- %{- "visitors" => 1,- "visits" => 1,- "name" => "/blog",- "visit_duration" => 60,- "bounce_rate" => 0,- "percentage" => 50.0- },- %{- "visitors" => 1,- "visits" => 1,- "name" => "/blog/john-2",- "visit_duration" => 0,- "bounce_rate" => 100,- "percentage" => 50.0- }+ assert response["results"] == [+ %{"dimensions" => ["/blog"], "metrics" => [1, 1, 0, 60, 50.0]},+ %{"dimensions" => ["/blog/john-2"], "metrics" => [1, 1, 100, 0, 50.0]}]end@@ -2420,6 +2086,10 @@ defmodule PlausibleWeb.Api.StatsController.PagesTest do])populate_stats(site, [+ build(:imported_visitors,+ date: ~D[2021-01-01],+ visitors: 2+ ),build(:imported_entry_pages,entry_page: "/page2",date: ~D[2021-01-01],@@ -2429,50 +2099,29 @@ defmodule PlausibleWeb.Api.StatsController.PagesTest do)])- conn1 = get(conn, "/api/stats/#{site.domain}/entry-pages?period=day&date=2021-01-01")+ response =+ query_pages(conn, site,+ date_range: ["2021-01-01", "2021-01-01"],+ dimensions: ["visit:entry_page"],+ metrics: ["visitors", "visits", "bounce_rate", "visit_duration", "percentage"]+ )- assert json_response(conn1, 200)["results"] == [- %{- "visitors" => 2,- "visits" => 2,- "name" => "/page1",- "visit_duration" => 0,- "bounce_rate" => 100,- "percentage" => 66.67- },- %{- "visitors" => 1,- "visits" => 2,- "name" => "/page2",- "visit_duration" => 450,- "bounce_rate" => 50,- "percentage" => 33.33- }+ assert response["results"] == [+ %{"dimensions" => ["/page1"], "metrics" => [2, 2, 100, 0, 66.67]},+ %{"dimensions" => ["/page2"], "metrics" => [1, 2, 50, 450, 33.33]}]- conn2 =- get(- conn,- "/api/stats/#{site.domain}/entry-pages?period=day&date=2021-01-01&with_imported=true"+ response =+ query_pages(conn, site,+ date_range: ["2021-01-01", "2021-01-01"],+ dimensions: ["visit:entry_page"],+ metrics: ["visitors", "visits", "bounce_rate", "visit_duration", "percentage"],+ include: %{"imports" => true})- assert json_response(conn2, 200)["results"] == [- %{- "visitors" => 3,- "visits" => 5,- "name" => "/page2",- "visit_duration" => 240.0,- "bounce_rate" => 20.0,- "percentage" => 60.0- },- %{- "visitors" => 2,- "visits" => 2,- "name" => "/page1",- "visit_duration" => 0.0,- "bounce_rate" => 100.0,- "percentage" => 40.0- }+ assert response["results"] == [+ %{"dimensions" => ["/page2"], "metrics" => [3, 5, 20.0, 240.0, 60.0]},+ %{"dimensions" => ["/page1"], "metrics" => [2, 2, 100.0, 0.0, 40.0]}]end@@ -2514,32 +2163,19 @@ defmodule PlausibleWeb.Api.StatsController.PagesTest do)])- filters = Jason.encode!([[:is, "event:hostname", ["es.example.com"]]])-- conn =- get(- conn,- "/api/stats/#{site.domain}/entry-pages?period=day&date=2021-01-01&filters=#{filters}"- )-# We're going to only join sessions where the exit hostname matches the filter- assert json_response(conn, 200)["results"] == [- %{- "name" => "/page1",- "visit_duration" => 0,- "visitors" => 1,- "visits" => 1,- "bounce_rate" => 100,- "percentage" => 50.0- },- %{- "name" => "/page2",- "visit_duration" => 0,- "visitors" => 1,- "visits" => 1,- "bounce_rate" => 100,- "percentage" => 50.0- }+ response =+ query_pages(conn, site,+ date_range: ["2021-01-01", "2021-01-01"],+ dimensions: ["visit:entry_page"],+ filters: [["is", "event:hostname", ["es.example.com"]]],+ metrics: ["visitors", "visits", "bounce_rate", "visit_duration", "percentage"],+ order_by: [["visitors", "desc"], ["visit:entry_page", "asc"]]+ )++ assert response["results"] == [+ %{"dimensions" => ["/page1"], "metrics" => [1, 1, 100, 0, 50.0]},+ %{"dimensions" => ["/page2"], "metrics" => [1, 1, 100, 0, 50.0]}]end@@ -2559,31 +2195,32 @@ defmodule PlausibleWeb.Api.StatsController.PagesTest doinsert(:goal, site: site, event_name: "Signup")request = fn conn, opts ->- page = Keyword.fetch!(opts, :page)- limit = Keyword.fetch!(opts, :limit)- filters = Jason.encode!([[:is, "event:goal", ["Signup"]]])-conn- |> get(- "/api/stats/#{site.domain}/pages?date=2021-01-01&period=day&filters=#{filters}&limit=#{limit}&page=#{page}"+ |> query_pages(site,+ metrics: ["visitors"],+ pagination: %{+ "offset" => Keyword.fetch!(opts, :offset),+ "limit" => Keyword.fetch!(opts, :limit)+ },+ filters: [["is", "event:goal", ["Signup"]]],+ order_by: [["event:page", "asc"]])- |> json_response(200)|> Map.get("results")- |> Enum.map(fn %{"name" => "/signup/" <> seq} ->+ |> Enum.map(fn %{"dimensions" => ["/signup/" <> seq]} ->seqend)end- assert List.first(request.(conn, page: 1, limit: 100)) == "01"- assert List.last(request.(conn, page: 1, limit: 100)) == "30"- assert List.last(request.(conn, page: 1, limit: 29)) == "29"- assert ["01", "02"] = request.(conn, page: 1, limit: 2)- assert ["03", "04"] = request.(conn, page: 2, limit: 2)- assert ["01", "02", "03", "04", "05"] = request.(conn, page: 1, limit: 5)- assert ["06", "07", "08", "09", "10"] = request.(conn, page: 2, limit: 5)- assert ["11", "12", "13", "14", "15"] = request.(conn, page: 3, limit: 5)- assert ["20"] = request.(conn, page: 20, limit: 1)- assert [] = request.(conn, page: 31, limit: 1)+ assert List.first(request.(conn, offset: 0, limit: 100)) == "01"+ assert List.last(request.(conn, offset: 0, limit: 100)) == "30"+ assert List.last(request.(conn, offset: 0, limit: 29)) == "29"+ assert ["01", "02"] = request.(conn, offset: 0, limit: 2)+ assert ["03", "04"] = request.(conn, offset: 2, limit: 2)+ assert ["01", "02", "03", "04", "05"] = request.(conn, offset: 0, limit: 5)+ assert ["06", "07", "08", "09", "10"] = request.(conn, offset: 5, limit: 5)+ assert ["11", "12", "13", "14", "15"] = request.(conn, offset: 10, limit: 5)+ assert ["20"] = request.(conn, offset: 19, limit: 1)+ assert [] = request.(conn, offset: 30, limit: 1)endtest "calculates conversion_rate when filtering for goal", %{conn: conn, site: site} do@@ -2621,31 +2258,26 @@ defmodule PlausibleWeb.Api.StatsController.PagesTest do])insert(:goal, site: site, event_name: "Signup")- filters = Jason.encode!([[:is, "event:goal", ["Signup"]]])- conn =- get(- conn,- "/api/stats/#{site.domain}/entry-pages?period=day&date=2021-01-01&filters=#{filters}"+ response =+ query_pages(conn, site,+ date_range: ["2021-01-01", "2021-01-01"],+ dimensions: ["visit:entry_page"],+ filters: [["is", "event:goal", ["Signup"]]],+ metrics: ["visitors", "group_conversion_rate", "total_visitors"],+ order_by: [["visitors", "desc"], ["visit:entry_page", "asc"]])- assert json_response(conn, 200)["results"] == [- %{- "total_visitors" => 2,- "visitors" => 1,- "name" => "/page1",- "conversion_rate" => 50.0- },- %{- "total_visitors" => 1,- "visitors" => 1,- "name" => "/page2",- "conversion_rate" => 100.0- }+ assert response["results"] == [+ %{"dimensions" => ["/page1"], "metrics" => [1, 50.0, 2]},+ %{"dimensions" => ["/page2"], "metrics" => [1, 100.0, 1]}]end- test "ignores entry pages from sessions with only custom events", %{conn: conn, site: site} do+ test "can filter out empty entry pages (sessions with only custom events)", %{+ conn: conn,+ site: site+ } dopopulate_stats(site, [build(:event,name: "Signup",@@ -2654,13 +2286,15 @@ defmodule PlausibleWeb.Api.StatsController.PagesTest do)])- conn =- get(- conn,- "/api/stats/#{site.domain}/entry-pages?period=day&date=2021-01-01"+ response =+ query_pages(conn, site,+ date_range: ["2021-01-01", "2021-01-01"],+ dimensions: ["visit:entry_page"],+ filters: [["is_not", "visit:entry_page", [""]]],+ metrics: ["visitors", "visits", "bounce_rate", "visit_duration", "percentage"])- assert json_response(conn, 200)["results"] == []+ assert response["results"] == []endtest "filter by :matches_member entry_page with imported data", %{conn: conn, site: site} do@@ -2686,36 +2320,19 @@ defmodule PlausibleWeb.Api.StatsController.PagesTest do)])- filters = Jason.encode!([[:contains, "visit:entry_page", ["/a", "/b"]]])- q = "?period=day&date=2021-01-01&filters=#{filters}&detailed=true&with_imported=true"-- conn = get(conn, "/api/stats/#{site.domain}/entry-pages#{q}")+ response =+ query_pages(conn, site,+ date_range: ["2021-01-01", "2021-01-01"],+ dimensions: ["visit:entry_page"],+ filters: [["contains", "visit:entry_page", ["/a", "/b"]]],+ metrics: ["visitors", "visits", "bounce_rate", "visit_duration", "percentage"],+ include: %{"imports" => true}+ )- assert json_response(conn, 200)["results"] == [- %{- "visit_duration" => 100.0,- "name" => "/a",- "visits" => 10,- "visitors" => 6,- "bounce_rate" => 10.0,- "percentage" => 66.67- },- %{- "visit_duration" => 50.0,- "name" => "/bbb",- "visits" => 2,- "visitors" => 2,- "bounce_rate" => 0.0,- "percentage" => 22.22- },- %{- "visit_duration" => 0,- "name" => "/aaa",- "visits" => 1,- "visitors" => 1,- "bounce_rate" => 100.0,- "percentage" => 11.11- }+ assert response["results"] == [+ %{"dimensions" => ["/a"], "metrics" => [6, 10, 10.0, 100.0, 66.67]},+ %{"dimensions" => ["/bbb"], "metrics" => [2, 2, 0.0, 50.0, 22.22]},+ %{"dimensions" => ["/aaa"], "metrics" => [1, 1, 100.0, 0, 11.11]}]endend@@ -2745,23 +2362,16 @@ defmodule PlausibleWeb.Api.StatsController.PagesTest do)])- conn = get(conn, "/api/stats/#{site.domain}/exit-pages?period=day&date=2021-01-01")+ response =+ query_pages(conn, site,+ date_range: ["2021-01-01", "2021-01-01"],+ dimensions: ["visit:exit_page"],+ metrics: ["visitors", "visits", "exit_rate", "percentage"]+ )- assert json_response(conn, 200)["results"] == [- %{- "name" => "/page1",- "visitors" => 2,- "visits" => 2,- "exit_rate" => 66.7,- "percentage" => 66.67- },- %{- "name" => "/page2",- "visitors" => 1,- "visits" => 1,- "exit_rate" => 100,- "percentage" => 33.33- }+ assert response["results"] == [+ %{"dimensions" => ["/page1"], "metrics" => [2, 2, 66.7, 66.67]},+ %{"dimensions" => ["/page2"], "metrics" => [1, 1, 100, 33.33]}]end@@ -2787,27 +2397,17 @@ defmodule PlausibleWeb.Api.StatsController.PagesTest do)])- conn =- get(- conn,- "/api/stats/#{site.domain}/exit-pages?period=day&date=2021-01-01&order_by=#{Jason.encode!([["visits", "asc"]])}"+ response =+ query_pages(conn, site,+ date_range: ["2021-01-01", "2021-01-01"],+ dimensions: ["visit:exit_page"],+ metrics: ["visitors", "visits", "exit_rate", "percentage"],+ order_by: [["visits", "asc"]])- assert json_response(conn, 200)["results"] == [- %{- "name" => "/page2",- "visitors" => 1,- "visits" => 1,- "exit_rate" => 100.0,- "percentage" => 33.33- },- %{- "name" => "/page1",- "visitors" => 2,- "visits" => 2,- "exit_rate" => 66.7,- "percentage" => 66.67- }+ assert response["results"] == [+ %{"dimensions" => ["/page2"], "metrics" => [1, 1, 100.0, 33.33]},+ %{"dimensions" => ["/page1"], "metrics" => [2, 2, 66.7, 66.67]}]end@@ -2844,17 +2444,18 @@ defmodule PlausibleWeb.Api.StatsController.PagesTest do)])- filters = Jason.encode!([[:is, "event:hostname", ["es.example.com"]]])-- conn =- get(- conn,- "/api/stats/#{site.domain}/exit-pages?period=day&date=2021-01-01&filters=#{filters}"+ response =+ query_pages(conn, site,+ date_range: ["2021-01-01", "2021-01-01"],+ dimensions: ["visit:exit_page"],+ filters: [["is", "event:hostname", ["es.example.com"]]],+ metrics: ["visitors", "visits", "percentage"])# We're going to only join sessions where the entry hostname matches the filter- assert json_response(conn, 200)["results"] ==- [%{"name" => "/page1", "visitors" => 1, "visits" => 1, "percentage" => 100.0}]+ assert response["results"] == [+ %{"dimensions" => ["/page1"], "metrics" => [1, 1, 100.0]}+ ]endtest "returns top exit pages filtered by custom pageview props", %{conn: conn, site: site} do@@ -2883,16 +2484,16 @@ defmodule PlausibleWeb.Api.StatsController.PagesTest do)])- filters = Jason.encode!([[:is, "event:props:author", ["John Doe"]]])-- conn =- get(- conn,- "/api/stats/#{site.domain}/exit-pages?period=day&date=2021-01-01&filters=#{filters}"+ response =+ query_pages(conn, site,+ date_range: ["2021-01-01", "2021-01-01"],+ dimensions: ["visit:exit_page"],+ filters: [["is", "event:props:author", ["John Doe"]]],+ metrics: ["visitors", "visits", "percentage"])- assert json_response(conn, 200)["results"] == [- %{"name" => "/", "visitors" => 1, "visits" => 1, "percentage" => 100.0}+ assert response["results"] == [+ %{"dimensions" => ["/"], "metrics" => [1, 1, 100.0]}]end@@ -2933,50 +2534,35 @@ defmodule PlausibleWeb.Api.StatsController.PagesTest do)])- conn1 = get(conn, "/api/stats/#{site.domain}/exit-pages?period=day&date=2021-01-01")+ response =+ query_pages(conn, site,+ date_range: ["2021-01-01", "2021-01-01"],+ dimensions: ["visit:exit_page"],+ filters: [["is_not", "visit:exit_page", [""]]],+ metrics: ["visitors", "visits", "exit_rate", "percentage"]+ )- assert json_response(conn1, 200)["results"] == [- %{- "name" => "/page1",- "visitors" => 2,- "visits" => 2,- "exit_rate" => 66.7,- "percentage" => 66.67- },- %{- "name" => "/page2",- "visitors" => 1,- "visits" => 1,- "exit_rate" => 100.0,- "percentage" => 33.33- }+ assert response["results"] == [+ %{"dimensions" => ["/page1"], "metrics" => [2, 2, 66.7, 66.67]},+ %{"dimensions" => ["/page2"], "metrics" => [1, 1, 100.0, 33.33]}]- conn2 =- get(- conn,- "/api/stats/#{site.domain}/exit-pages?period=day&date=2021-01-01&with_imported=true"+ response =+ query_pages(conn, site,+ date_range: ["2021-01-01", "2021-01-01"],+ dimensions: ["visit:exit_page"],+ filters: [["is_not", "visit:exit_page", [""]]],+ metrics: ["visitors", "visits", "exit_rate", "percentage"],+ include: %{"imports" => true})- assert json_response(conn2, 200)["results"] == [- %{- "name" => "/page2",- "visitors" => 3,- "visits" => 4,- "exit_rate" => 80.0,- "percentage" => 60.0- },- %{- "name" => "/page1",- "visitors" => 2,- "visits" => 2,- "exit_rate" => 66.7,- "percentage" => 40.0- }+ assert response["results"] == [+ %{"dimensions" => ["/page2"], "metrics" => [3, 4, 80.0, 60.0]},+ %{"dimensions" => ["/page1"], "metrics" => [2, 2, 66.7, 40.0]}]end- test "calculates correct exit rate and conversion_rate when filtering for goal", %{+ test "returns top exit pages when filtering for goal", %{conn: conn,site: site} do@@ -3009,31 +2595,23 @@ defmodule PlausibleWeb.Api.StatsController.PagesTest do])insert(:goal, site: site, event_name: "Signup")- filters = Jason.encode!([[:is, "event:goal", ["Signup"]]])- conn =- get(- conn,- "/api/stats/#{site.domain}/exit-pages?period=day&date=2021-01-01&filters=#{filters}"+ response =+ query_pages(conn, site,+ date_range: ["2021-01-01", "2021-01-01"],+ dimensions: ["visit:exit_page"],+ filters: [["is", "event:goal", ["Signup"]]],+ metrics: ["visitors", "group_conversion_rate", "total_visitors"],+ order_by: [["visitors", "desc"], ["visit:exit_page", "asc"]])- assert json_response(conn, 200)["results"] == [- %{- "name" => "/exit1",- "visitors" => 1,- "total_visitors" => 1,- "conversion_rate" => 100.0- },- %{- "name" => "/exit2",- "visitors" => 1,- "total_visitors" => 1,- "conversion_rate" => 100.0- }+ assert response["results"] == [+ %{"dimensions" => ["/exit1"], "metrics" => [1, 100.0, 1]},+ %{"dimensions" => ["/exit2"], "metrics" => [1, 100.0, 1]}]end- test "calculates correct exit rate when filtering for page", %{conn: conn, site: site} do+ test "returns top exit pages when filtering for page", %{conn: conn, site: site} dopopulate_stats(site, [build(:pageview,user_id: 1,@@ -3062,21 +2640,24 @@ defmodule PlausibleWeb.Api.StatsController.PagesTest do)])- filters = Jason.encode!([[:is, "event:page", ["/exit1"]]])-- conn =- get(- conn,- "/api/stats/#{site.domain}/exit-pages?period=day&date=2021-01-01&filters=#{filters}"+ response =+ query_pages(conn, site,+ date_range: ["2021-01-01", "2021-01-01"],+ dimensions: ["visit:exit_page"],+ filters: [["is", "event:page", ["/exit1"]]],+ metrics: ["visitors", "visits", "percentage"])- assert json_response(conn, 200)["results"] == [- %{"name" => "/exit1", "visitors" => 1, "visits" => 1, "percentage" => 50.0},- %{"name" => "/exit2", "visitors" => 1, "visits" => 1, "percentage" => 50.0}+ assert response["results"] == [+ %{"dimensions" => ["/exit1"], "metrics" => [1, 1, 50.0]},+ %{"dimensions" => ["/exit2"], "metrics" => [1, 1, 50.0]}]end- test "ignores exit pages from sessions with only custom events", %{conn: conn, site: site} do+ test "can filter out empty exit pages (sessions with only custom events)", %{+ conn: conn,+ site: site+ } dopopulate_stats(site, [build(:event,name: "Signup",@@ -3085,13 +2666,15 @@ defmodule PlausibleWeb.Api.StatsController.PagesTest do)])- conn =- get(- conn,- "/api/stats/#{site.domain}/exit-pages?period=day&date=2021-01-01"+ response =+ query_pages(conn, site,+ date_range: ["2021-01-01", "2021-01-01"],+ dimensions: ["visit:exit_page"],+ filters: [["is_not", "visit:exit_page", [""]]],+ metrics: ["visitors", "visits", "exit_rate", "percentage"])- assert json_response(conn, 200)["results"] == []+ assert response["results"] == []endtest "filter by :is_not exit_page with imported data", %{conn: conn, site: site} do@@ -3119,33 +2702,19 @@ defmodule PlausibleWeb.Api.StatsController.PagesTest dobuild(:imported_pages, page: "/bbb", pageviews: 2, date: ~D[2021-01-01])])- filters = Jason.encode!([[:is_not, "visit:exit_page", ["/ignored"]]])- q = "?period=day&date=2021-01-01&filters=#{filters}&detailed=true&with_imported=true"-- conn = get(conn, "/api/stats/#{site.domain}/exit-pages#{q}")+ response =+ query_pages(conn, site,+ date_range: ["2021-01-01", "2021-01-01"],+ dimensions: ["visit:exit_page"],+ filters: [["is_not", "visit:exit_page", ["/ignored"]]],+ metrics: ["visitors", "visits", "exit_rate", "percentage"],+ include: %{"imports" => true}+ )- assert json_response(conn, 200)["results"] == [- %{- "exit_rate" => 50.0,- "name" => "/a",- "visits" => 10,- "visitors" => 6,- "percentage" => 66.67- },- %{- "exit_rate" => 100.0,- "name" => "/bbb",- "visits" => 2,- "visitors" => 2,- "percentage" => 22.22- },- %{- "exit_rate" => 100.0,- "name" => "/aaa",- "visits" => 1,- "visitors" => 1,- "percentage" => 11.11- }+ assert response["results"] == [+ %{"dimensions" => ["/a"], "metrics" => [6, 10, 50.0, 66.67]},+ %{"dimensions" => ["/bbb"], "metrics" => [2, 2, 100.0, 22.22]},+ %{"dimensions" => ["/aaa"], "metrics" => [1, 1, 100.0, 11.11]}]end@@ -3192,71 +2761,81 @@ defmodule PlausibleWeb.Api.StatsController.PagesTest doinsert(:goal, %{site: site, event_name: "Payment", currency: :USD})- filters = Jason.encode!([[:is, "event:goal", ["Payment"]]])- order_by = Jason.encode!([["visitors", "desc"]])-- q = "?filters=#{filters}&order_by=#{order_by}&detailed=true&period=day&page=1&limit=100"-- conn =- get(- conn,- "/api/stats/#{site.domain}/entry-pages#{q}"- )-- assert json_response(conn, 200)["results"] == [- %{- "average_revenue" => %{- "currency" => "USD",- "long" => "$1,500.00",- "short" => "$1.5K",- "value" => 1500.0- },- "conversion_rate" => 100.0,- "name" => "/first",- "total_revenue" => %{- "currency" => "USD",- "long" => "$3,000.00",- "short" => "$3.0K",- "value" => 3000.0- },- "total_visitors" => 2,- "visitors" => 2+ response =+ query_pages(conn, site,+ date_range: "day",+ dimensions: ["visit:entry_page"],+ filters: [["is", "event:goal", ["Payment"]], ["is_not", "visit:entry_page", [""]]],+ metrics: [+ "visitors",+ "group_conversion_rate",+ "total_visitors",+ "average_revenue",+ "total_revenue"+ ],+ order_by: [["visitors", "desc"], ["visit:entry_page", "asc"]]+ )++ assert response["results"] == [+ %{+ "dimensions" => ["/first"],+ "metrics" => [+ 2,+ 100.0,+ 2,+ %{+ "currency" => "USD",+ "long" => "$1,500.00",+ "short" => "$1.5K",+ "value" => 1500.0+ },+ %{+ "currency" => "USD",+ "long" => "$3,000.00",+ "short" => "$3.0K",+ "value" => 3000.0+ }+ ]},%{- "average_revenue" => %{- "currency" => "USD",- "long" => "$3,500.00",- "short" => "$3.5K",- "value" => 3500.0- },- "conversion_rate" => 100.0,- "name" => "/second",- "total_revenue" => %{- "currency" => "USD",- "long" => "$7,000.00",- "short" => "$7.0K",- "value" => 7000.0- },- "total_visitors" => 1,- "visitors" => 1+ "dimensions" => ["/second"],+ "metrics" => [+ 1,+ 100.0,+ 1,+ %{+ "currency" => "USD",+ "long" => "$3,500.00",+ "short" => "$3.5K",+ "value" => 3500.0+ },+ %{+ "currency" => "USD",+ "long" => "$7,000.00",+ "short" => "$7.0K",+ "value" => 7000.0+ }+ ]},%{- "average_revenue" => %{- "currency" => "USD",- "long" => "$2,500.00",- "short" => "$2.5K",- "value" => 2500.0- },- "conversion_rate" => 100.0,- "name" => "/third",- "total_revenue" => %{- "currency" => "USD",- "long" => "$2,500.00",- "short" => "$2.5K",- "value" => 2500.0- },- "total_visitors" => 1,- "visitors" => 1+ "dimensions" => ["/third"],+ "metrics" => [+ 1,+ 100.0,+ 1,+ %{+ "currency" => "USD",+ "long" => "$2,500.00",+ "short" => "$2.5K",+ "value" => 2500.0+ },+ %{+ "currency" => "USD",+ "long" => "$2,500.00",+ "short" => "$2.5K",+ "value" => 2500.0+ }+ ]}]end@@ -3307,71 +2886,81 @@ defmodule PlausibleWeb.Api.StatsController.PagesTest doinsert(:goal, %{site: site, event_name: "Payment", currency: :USD})- filters = Jason.encode!([[:is, "event:goal", ["Payment"]]])- order_by = Jason.encode!([["visitors", "desc"]])-- q = "?filters=#{filters}&order_by=#{order_by}&detailed=true&period=day&page=1&limit=100"-- conn =- get(- conn,- "/api/stats/#{site.domain}/exit-pages#{q}"- )-- assert json_response(conn, 200)["results"] == [- %{- "average_revenue" => %{- "currency" => "USD",- "long" => "$1,500.00",- "short" => "$1.5K",- "value" => 1500.0- },- "conversion_rate" => 100.0,- "name" => "/exit_first",- "total_revenue" => %{- "currency" => "USD",- "long" => "$3,000.00",- "short" => "$3.0K",- "value" => 3000.0- },- "total_visitors" => 2,- "visitors" => 2+ response =+ query_pages(conn, site,+ date_range: "day",+ dimensions: ["visit:exit_page"],+ filters: [["is", "event:goal", ["Payment"]], ["is_not", "visit:exit_page", [""]]],+ metrics: [+ "visitors",+ "group_conversion_rate",+ "total_visitors",+ "average_revenue",+ "total_revenue"+ ],+ order_by: [["visitors", "desc"], ["visit:exit_page", "asc"]]+ )++ assert response["results"] == [+ %{+ "dimensions" => ["/exit_first"],+ "metrics" => [+ 2,+ 100.0,+ 2,+ %{+ "currency" => "USD",+ "long" => "$1,500.00",+ "short" => "$1.5K",+ "value" => 1500.0+ },+ %{+ "currency" => "USD",+ "long" => "$3,000.00",+ "short" => "$3.0K",+ "value" => 3000.0+ }+ ]},%{- "average_revenue" => %{- "currency" => "USD",- "long" => "$3,500.00",- "short" => "$3.5K",- "value" => 3500.0- },- "conversion_rate" => 100.0,- "name" => "/exit_second",- "total_revenue" => %{- "currency" => "USD",- "long" => "$7,000.00",- "short" => "$7.0K",- "value" => 7000.0- },- "total_visitors" => 1,- "visitors" => 1+ "dimensions" => ["/exit_second"],+ "metrics" => [+ 1,+ 100.0,+ 1,+ %{+ "currency" => "USD",+ "long" => "$3,500.00",+ "short" => "$3.5K",+ "value" => 3500.0+ },+ %{+ "currency" => "USD",+ "long" => "$7,000.00",+ "short" => "$7.0K",+ "value" => 7000.0+ }+ ]},%{- "average_revenue" => %{- "currency" => "USD",- "long" => "$2,500.00",- "short" => "$2.5K",- "value" => 2500.0- },- "conversion_rate" => 100.0,- "name" => "/third",- "total_revenue" => %{- "currency" => "USD",- "long" => "$2,500.00",- "short" => "$2.5K",- "value" => 2500.0- },- "total_visitors" => 1,- "visitors" => 1+ "dimensions" => ["/third"],+ "metrics" => [+ 1,+ 100.0,+ 1,+ %{+ "currency" => "USD",+ "long" => "$2,500.00",+ "short" => "$2.5K",+ "value" => 2500.0+ },+ %{+ "currency" => "USD",+ "long" => "$2,500.00",+ "short" => "$2.5K",+ "value" => 2500.0+ }+ ]}]end@@ -3428,89 +3017,89 @@ defmodule PlausibleWeb.Api.StatsController.PagesTest doinsert(:goal, %{site: site, event_name: "Payment", currency: :USD})- filters = Jason.encode!([[:is, "event:goal", ["Payment"]]])- order_by = Jason.encode!([["visitors", "desc"]])-- q = "?filters=#{filters}&order_by=#{order_by}&detailed=true&period=day&page=1&limit=100"-- conn =- get(- conn,- "/api/stats/#{site.domain}/pages#{q}"- )-- assert json_response(conn, 200)["results"] == [- %{- "average_revenue" => %{- "currency" => "USD",- "long" => "$0.00",- "short" => "$0.0",- "value" => 0.0- },- "conversion_rate" => 100.0,- "name" => "/nopay",- "total_revenue" => %{- "currency" => "USD",- "long" => "$0.00",- "short" => "$0.0",- "value" => 0.0- },- "total_visitors" => 3,- "visitors" => 3+ response =+ query_pages(conn, site,+ date_range: "day",+ filters: [["is", "event:goal", ["Payment"]]],+ metrics: [+ "visitors",+ "group_conversion_rate",+ "total_visitors",+ "average_revenue",+ "total_revenue"+ ]+ )++ assert response["results"] == [+ %{+ "dimensions" => ["/nopay"],+ "metrics" => [+ 3,+ 100.0,+ 3,+ %{"currency" => "USD", "long" => "$0.00", "short" => "$0.0", "value" => 0.0},+ %{"currency" => "USD", "long" => "$0.00", "short" => "$0.0", "value" => 0.0}+ ]},%{- "average_revenue" => %{- "currency" => "USD",- "long" => "$1,500.00",- "short" => "$1.5K",- "value" => 1500.0- },- "conversion_rate" => 100.0,- "name" => "/purchase/first",- "total_revenue" => %{- "currency" => "USD",- "long" => "$3,000.00",- "short" => "$3.0K",- "value" => 3000.0- },- "total_visitors" => 2,- "visitors" => 2+ "dimensions" => ["/purchase/first"],+ "metrics" => [+ 2,+ 100.0,+ 2,+ %{+ "currency" => "USD",+ "long" => "$1,500.00",+ "short" => "$1.5K",+ "value" => 1500.0+ },+ %{+ "currency" => "USD",+ "long" => "$3,000.00",+ "short" => "$3.0K",+ "value" => 3000.0+ }+ ]},%{- "average_revenue" => %{- "currency" => "USD",- "long" => "$3,500.00",- "short" => "$3.5K",- "value" => 3500.0- },- "conversion_rate" => 100.0,- "name" => "/purchase/second",- "total_revenue" => %{- "currency" => "USD",- "long" => "$7,000.00",- "short" => "$7.0K",- "value" => 7000.0- },- "total_visitors" => 1,- "visitors" => 1+ "dimensions" => ["/purchase/second"],+ "metrics" => [+ 1,+ 100.0,+ 1,+ %{+ "currency" => "USD",+ "long" => "$3,500.00",+ "short" => "$3.5K",+ "value" => 3500.0+ },+ %{+ "currency" => "USD",+ "long" => "$7,000.00",+ "short" => "$7.0K",+ "value" => 7000.0+ }+ ]},%{- "average_revenue" => %{- "currency" => "USD",- "long" => "$2,500.00",- "short" => "$2.5K",- "value" => 2500.0- },- "conversion_rate" => 100.0,- "name" => "/purchase/third",- "total_revenue" => %{- "currency" => "USD",- "long" => "$2,500.00",- "short" => "$2.5K",- "value" => 2500.0- },- "total_visitors" => 1,- "visitors" => 1+ "dimensions" => ["/purchase/third"],+ "metrics" => [+ 1,+ 100.0,+ 1,+ %{+ "currency" => "USD",+ "long" => "$2,500.00",+ "short" => "$2.5K",+ "value" => 2500.0+ },+ %{+ "currency" => "USD",+ "long" => "$2,500.00",+ "short" => "$2.5K",+ "value" => 2500.0+ }+ ]}]end