Adds entry and exit pages to Top Pages module (#712)

* Initial Pass

* Adds support for page visits counting by referrer

* Includes goal selection in entry and exit computation

* Adds goal-based entry and exit page stats, formatting, code cleanup

* Changelog

* Format

* Exit rate, visit duration, updated tests

* I keep forgetting to format :/

* Tests, last time

* Fixes double counting, exit rate >100%, relevant tests

* Fixes exit pages on filter and goal states

* Adds entry and exit filters, fixes various bugs

* Fixes discussed issues

* Format

* Fixes impossible case in tests

Originally, there were only 2 pageviews for `test-site.com`,`/` on `2019-01-01`, but that doesn't make sense when there were 3 sessions that exited on the same site/date.

* Format

* Removes boolean function parameter in favor of separate function

* Adds support for queries that use `page` filter as `entry-page`

* Format

* Makes  loader/title interaction in sources report consistent
pull/762/head
Vignesh Joglekar 6 years ago committed by GitHub
parent 98afadcb6d
commit ff32218bd0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -5,6 +5,7 @@ All notable changes to this project will be documented in this file.
### Added
- Stats API [currently in beta] plausible/analytics#679
- Ability to view and filter by entry and exit pages, in addition to regular page hits plausible/analytics#712
- 30 day and 6 month keybindings (`T` and `S`, respectively) plausible/analytics#709
- Site switching keybinds (1-9 for respective sites) plausible/analytics#735

@ -150,6 +150,12 @@ class Filters extends React.Component {
if (key === "page") {
return <span className="inline-block max-w-2xs md:max-w-xs truncate">Page: <b>{value}</b></span>
}
if (key === "entry_page") {
return <span className="inline-block max-w-2xs md:max-w-xs truncate">Entry Page: <b>{value}</b></span>
}
if (key === "exit_page") {
return <span className="inline-block max-w-2xs md:max-w-xs truncate">Exit Page: <b>{value}</b></span>
}
}
removeFilter(key, history, query) {

@ -6,7 +6,7 @@ import Filters from './filters'
import CurrentVisitors from './stats/current-visitors'
import VisitorGraph from './stats/visitor-graph'
import Sources from './stats/sources'
import Pages from './stats/pages'
import Pages from './stats/pages/'
import Countries from './stats/countries'
import Devices from './stats/devices'
import Conversions from './stats/conversions'

@ -36,7 +36,9 @@ export function parseQuery(querystring, site) {
'os': q.get('os'),
'os_version': q.get('os_version'),
'country': q.get('country'),
'page': q.get('page')
'page': q.get('page'),
'entry_page': q.get('entry_page'),
'exit_page': q.get('exit_page')
}
}
}

@ -6,7 +6,7 @@ import Filters from './filters'
import CurrentVisitors from './stats/current-visitors'
import VisitorGraph from './stats/visitor-graph'
import Sources from './stats/sources'
import Pages from './stats/pages'
import Pages from './stats/pages/'
import Countries from './stats/countries'
import Devices from './stats/devices'
import Conversions from './stats/conversions'

@ -4,6 +4,8 @@ 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 CountriesModal from './stats/modals/countries'
import {BrowserRouter, Switch, Route, useLocation} from "react-router-dom";
@ -39,6 +41,12 @@ export default function Router({site, loggedIn}) {
<Route path="/:domain/pages">
<PagesModal site={site} />
</Route>
<Route path="/:domain/entry-pages">
<EntryPagesModal site={site} />
</Route>
<Route path="/:domain/exit-pages">
<ExitPagesModal site={site} />
</Route>
<Route path="/:domain/countries">
<CountriesModal site={site} />
</Route>

@ -0,0 +1,116 @@
import React from "react";
import { Link } from 'react-router-dom'
import { withRouter } from 'react-router-dom'
import Modal from './modal'
import * as api from '../../api'
import numberFormatter, { durationFormatter } from '../../number-formatter'
import {parseQuery} from '../../query'
class EntryPagesModal extends React.Component {
constructor(props) {
super(props)
this.state = {
loading: true,
query: parseQuery(props.location.search, props.site),
pages: [],
page: 1,
moreResultsAvailable: false
}
}
componentDidMount() {
this.loadPages();
}
loadPages() {
const {query, page, pages} = this.state;
api.get(`/api/stats/${encodeURIComponent(this.props.site.domain)}/entry-pages`, query, {limit: 100, page})
.then((res) => this.setState((state) => ({loading: false, pages: state.pages.concat(res), moreResultsAvailable: res.length === 100})))
}
loadMore() {
this.setState({loading: true, page: this.state.page + 1}, this.loadPages.bind(this))
}
showVisitDuration() {
return this.state.query.period !== 'realtime'
}
formatBounceRate(page) {
if (typeof(page.bounce_rate) === 'number') {
return page.bounce_rate + '%'
} else {
return '-'
}
}
renderPage(page) {
const query = new URLSearchParams(window.location.search)
query.set('entry_page', page.name)
return (
<tr className="text-sm dark:text-gray-200" key={page.name}>
<td className="p-2">
<Link to={{pathname: `/${encodeURIComponent(this.props.site.domain)}`, search: query.toString()}} className="hover:underline">{page.name}</Link>
</td>
<td className="p-2 w-32 font-medium" align="right">{numberFormatter(page.count)}</td>
<td className="p-2 w-32 font-medium" align="right">{numberFormatter(page.entries)}</td>
{this.showVisitDuration() && <td className="p-2 w-32 font-medium" align="right">{durationFormatter(page.visit_duration)}</td>}
</tr>
)
}
renderLoading() {
if (this.state.loading) {
return <div className="loading my-16 mx-auto"><div></div></div>
} else if (this.state.moreResultsAvailable) {
return (
<div className="w-full text-center my-4">
<button onClick={this.loadMore.bind(this)} type="button" className="button">
Load more
</button>
</div>
)
}
}
renderBody() {
if (this.state.pages) {
return (
<React.Fragment>
<h1 className="text-xl font-bold dark:text-gray-100">Entry Pages</h1>
<div className="my-4 border-b border-gray-300"></div>
<main className="modal__content">
<table className="w-full table-striped table-fixed">
<thead>
<tr>
<th className="p-2 text-xs tracking-wide font-bold text-gray-500 dark:text-gray-400" align="left">Page url</th>
<th className="p-2 w-32 text-xs tracking-wide font-bold text-gray-500 dark:text-gray-400" align="right">Unique Entrances</th>
<th className="p-2 w-32 text-xs tracking-wide font-bold text-gray-500 dark:text-gray-400" align="right">Total Entrances</th>
{<th className="p-2 w-32 text-xs tracking-wide font-bold text-gray-500 dark:text-gray-400" align="right">Visit Duration</th>}
</tr>
</thead>
<tbody>
{ this.state.pages.map(this.renderPage.bind(this)) }
</tbody>
</table>
</main>
</React.Fragment>
)
}
}
render() {
return (
<Modal site={this.props.site}>
{ this.renderBody() }
{ this.renderLoading() }
</Modal>
)
}
}
export default withRouter(EntryPagesModal)

@ -0,0 +1,112 @@
import React from "react";
import { Link } from 'react-router-dom'
import { withRouter } from 'react-router-dom'
import Modal from './modal'
import * as api from '../../api'
import numberFormatter from '../../number-formatter'
import {parseQuery} from '../../query'
class ExitPagesModal extends React.Component {
constructor(props) {
super(props)
this.state = {
loading: true,
query: parseQuery(props.location.search, props.site),
pages: [],
page: 1,
moreResultsAvailable: false
}
}
componentDidMount() {
this.loadPages();
}
loadPages() {
const {query, page, pages} = this.state;
api.get(`/api/stats/${encodeURIComponent(this.props.site.domain)}/exit-pages`, query, {limit: 100, page})
.then((res) => this.setState((state) => ({loading: false, pages: state.pages.concat(res), moreResultsAvailable: res.length === 100})))
}
loadMore() {
this.setState({loading: true, page: this.state.page + 1}, this.loadPages.bind(this))
}
formatPercentage(number) {
if (typeof(number) === 'number') {
return number + '%'
} else {
return '-'
}
}
renderPage(page) {
const query = new URLSearchParams(window.location.search)
query.set('exit_page', page.name)
return (
<tr className="text-sm dark:text-gray-200" key={page.name}>
<td className="p-2">
<Link to={{pathname: `/${encodeURIComponent(this.props.site.domain)}`, search: query.toString()}} className="hover:underline">{page.name}</Link>
</td>
<td className="p-2 w-32 font-medium" align="right">{numberFormatter(page.count)}</td>
<td className="p-2 w-32 font-medium" align="right">{numberFormatter(page.exits)}</td>
<td className="p-2 w-32 font-medium" align="right">{this.formatPercentage(page.exit_rate)}</td>
</tr>
)
}
renderLoading() {
if (this.state.loading) {
return <div className="loading my-16 mx-auto"><div></div></div>
} else if (this.state.moreResultsAvailable) {
return (
<div className="w-full text-center my-4">
<button onClick={this.loadMore.bind(this)} type="button" className="button">
Load more
</button>
</div>
)
}
}
renderBody() {
if (this.state.pages) {
return (
<React.Fragment>
<h1 className="text-xl font-bold dark:text-gray-100">Exit Pages</h1>
<div className="my-4 border-b border-gray-300"></div>
<main className="modal__content">
<table className="w-full table-striped table-fixed">
<thead>
<tr>
<th className="p-2 text-xs tracking-wide font-bold text-gray-500 dark:text-gray-400" align="left">Page url</th>
<th className="p-2 w-32 text-xs tracking-wide font-bold text-gray-500 dark:text-gray-400" align="right">Unique Exits</th>
<th className="p-2 w-32 text-xs tracking-wide font-bold text-gray-500 dark:text-gray-400" align="right">Total Exits</th>
<th className="p-2 w-32 text-xs tracking-wide font-bold text-gray-500 dark:text-gray-400" align="right">Exit Rate</th>
</tr>
</thead>
<tbody>
{ this.state.pages.map(this.renderPage.bind(this)) }
</tbody>
</table>
</main>
</React.Fragment>
)
}
}
render() {
return (
<Modal site={this.props.site}>
{ this.renderBody() }
{ this.renderLoading() }
</Modal>
)
}
}
export default withRouter(ExitPagesModal)

@ -18,8 +18,8 @@ class Modal extends React.Component {
}
componentWillUnmount() {
document.body.style.overflow = 'unset';
document.body.style.height = 'unset';
document.body.style.overflow = null;
document.body.style.height = null;
document.removeEventListener("mousedown", this.handleClickOutside);
document.removeEventListener("keyup", this.handleKeyup);
}

@ -7,7 +7,7 @@ export default function MoreLink({site, list, endpoint}) {
<div className="text-center w-full absolute bottom-0 left-0 pb-3">
<Link to={`/${encodeURIComponent(site.domain)}/${endpoint}${window.location.search}`} className="leading-snug font-bold text-sm text-gray-500 dark:text-gray-400 hover:text-red-500 dark:hover:text-red-400 transition tracking-wide">
<svg className="feather mr-1" style={{marginTop: '-2px'}} xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" strokeWidth="2" strokeLinecap="round" strokeLinejoin="round"><path d="M8 3H5a2 2 0 0 0-2 2v3m18 0V5a2 2 0 0 0-2-2h-3m0 18h3a2 2 0 0 0 2-2v-3M3 16v3a2 2 0 0 0 2 2h3"/></svg>
MORE
DETAILS
</Link>
</div>
)

@ -0,0 +1,86 @@
import React from 'react';
import { Link } from 'react-router-dom'
import FlipMove from 'react-flip-move';
import FadeIn from '../../fade-in'
import Bar from '../bar'
import MoreLink from '../more-link'
import numberFormatter from '../../number-formatter'
import { eventName } from '../../query'
import * as api from '../../api'
export default class EntryPages extends React.Component {
constructor(props) {
super(props)
this.state = {loading: true}
}
componentDidMount() {
this.fetchPages()
if (this.props.timer) this.props.timer.onTick(this.fetchPages.bind(this))
}
componentDidUpdate(prevProps) {
if (this.props.query !== prevProps.query) {
this.setState({loading: true, pages: null})
this.fetchPages()
}
}
fetchPages() {
api.get(`/api/stats/${encodeURIComponent(this.props.site.domain)}/entry-pages`, this.props.query)
.then((res) => this.setState({loading: false, pages: res}))
}
renderPage(page) {
const query = new URLSearchParams(window.location.search)
query.set('entry_page', page.name)
return (
<div className="flex items-center justify-between my-1 text-sm" key={page.name}>
<div className="w-full h-8 truncate" style={{maxWidth: 'calc(100% - 4rem)'}}>
<Bar count={page.count} all={this.state.pages} bg="bg-orange-50 dark:bg-gray-500 dark:bg-opacity-15" />
<span className="flex px-2 group dark:text-gray-300" style={{marginTop: '-26px'}} >
<Link to={{pathname: window.location.pathname, search: query.toString()}} className="block hover:underline">{page.name}</Link>
<a target="_blank" href={'http://' + this.props.site.domain + page.name} className="hidden group-hover:block">
<svg className="inline h-4 w-4 ml-1 -mt-1 text-gray-600 dark:text-gray-400" fill="currentColor" viewBox="0 0 20 20"><path d="M11 3a1 1 0 100 2h2.586l-6.293 6.293a1 1 0 101.414 1.414L15 6.414V9a1 1 0 102 0V4a1 1 0 00-1-1h-5z"></path><path d="M5 5a2 2 0 00-2 2v8a2 2 0 002 2h8a2 2 0 002-2v-3a1 1 0 10-2 0v3H5V7h3a1 1 0 000-2H5z"></path></svg>
</a>
</span>
</div>
<span className="font-medium dark:text-gray-200">{numberFormatter(page.count)}</span>
</div>
)
}
renderList() {
if (this.state.pages && this.state.pages.length > 0) {
return (
<React.Fragment>
<div className="flex items-center mt-3 mb-2 justify-between text-gray-500 dark:text-gray-400 text-xs font-bold tracking-wide">
<span>Page url</span>
<span>Unique Entrances</span>
</div>
<FlipMove>
{ this.state.pages.map(this.renderPage.bind(this)) }
</FlipMove>
</React.Fragment>
)
} else {
return <div className="text-center mt-44 font-medium text-gray-500 dark:text-gray-400">No data yet</div>
}
}
render() {
const { loading } = this.state;
return (
<React.Fragment>
{ loading && <div className="loading mt-44 mx-auto"><div></div></div> }
<FadeIn show={!loading}>
{ this.renderList() }
</FadeIn>
{!loading && <MoreLink site={this.props.site} list={this.state.pages} endpoint="entry-pages" />}
</React.Fragment>
)
}
}

@ -0,0 +1,86 @@
import React from 'react';
import { Link } from 'react-router-dom'
import FlipMove from 'react-flip-move';
import FadeIn from '../../fade-in'
import Bar from '../bar'
import MoreLink from '../more-link'
import numberFormatter from '../../number-formatter'
import { eventName } from '../../query'
import * as api from '../../api'
export default class ExitPages extends React.Component {
constructor(props) {
super(props)
this.state = {loading: true}
}
componentDidMount() {
this.fetchPages()
if (this.props.timer) this.props.timer.onTick(this.fetchPages.bind(this))
}
componentDidUpdate(prevProps) {
if (this.props.query !== prevProps.query) {
this.setState({loading: true, pages: null})
this.fetchPages()
}
}
fetchPages() {
api.get(`/api/stats/${encodeURIComponent(this.props.site.domain)}/exit-pages`, this.props.query)
.then((res) => this.setState({loading: false, pages: res}))
}
renderPage(page) {
const query = new URLSearchParams(window.location.search)
query.set('exit_page', page.name)
return (
<div className="flex items-center justify-between my-1 text-sm" key={page.name}>
<div className="w-full h-8 truncate" style={{maxWidth: 'calc(100% - 4rem)'}}>
<Bar count={page.count} all={this.state.pages} bg="bg-orange-50 dark:bg-gray-500 dark:bg-opacity-15" />
<span className="flex px-2 group dark:text-gray-300" style={{marginTop: '-26px'}} >
<Link to={{pathname: window.location.pathname, search: query.toString()}} className="block hover:underline">{page.name}</Link>
<a target="_blank" href={'http://' + this.props.site.domain + page.name} className="hidden group-hover:block">
<svg className="inline h-4 w-4 ml-1 -mt-1 text-gray-600 dark:text-gray-400" fill="currentColor" viewBox="0 0 20 20"><path d="M11 3a1 1 0 100 2h2.586l-6.293 6.293a1 1 0 101.414 1.414L15 6.414V9a1 1 0 102 0V4a1 1 0 00-1-1h-5z"></path><path d="M5 5a2 2 0 00-2 2v8a2 2 0 002 2h8a2 2 0 002-2v-3a1 1 0 10-2 0v3H5V7h3a1 1 0 000-2H5z"></path></svg>
</a>
</span>
</div>
<span className="font-medium dark:text-gray-200">{numberFormatter(page.count)}</span>
</div>
)
}
renderList() {
if (this.state.pages && this.state.pages.length > 0) {
return (
<React.Fragment>
<div className="flex items-center mt-3 mb-2 justify-between text-gray-500 dark:text-gray-400 text-xs font-bold tracking-wide">
<span>Page url</span>
<span>Unique Exits</span>
</div>
<FlipMove>
{ this.state.pages.map(this.renderPage.bind(this)) }
</FlipMove>
</React.Fragment>
)
} else {
return <div className="text-center mt-44 font-medium text-gray-500 dark:text-gray-400">No data yet</div>
}
}
render() {
const { loading } = this.state;
return (
<React.Fragment>
{ loading && <div className="loading mt-44 mx-auto"><div></div></div> }
<FadeIn show={!loading}>
{ this.renderList() }
</FadeIn>
{!loading && <MoreLink site={this.props.site} list={this.state.pages} endpoint="exit-pages" />}
</React.Fragment>
)
}
}

@ -0,0 +1,74 @@
import React from 'react';
import { Link } from 'react-router-dom'
import Visits from './pages'
import EntryPages from './entry-pages'
import ExitPages from './exit-pages'
import FadeIn from '../../fade-in'
const labelFor = {
'pages': 'Top Pages',
'entry-pages': 'Entry Pages',
'exit-pages': 'Exit Pages',
}
export default class Pages extends React.Component {
constructor(props) {
super(props)
this.tabKey = 'pageTab__' + props.site.domain
const storedTab = window.localStorage[this.tabKey]
this.state = {
mode: storedTab || 'pages'
}
}
renderContent() {
if (this.state.mode === 'pages') {
return <Visits site={this.props.site} query={this.props.query} timer={this.props.timer} />
} else if (this.state.mode === 'entry-pages') {
return <EntryPages site={this.props.site} query={this.props.query} timer={this.props.timer} />
} else if (this.state.mode === 'exit-pages') {
return <ExitPages site={this.props.site} query={this.props.query} timer={this.props.timer} />
}
}
setMode(mode) {
return () => {
window.localStorage[this.tabKey] = mode
this.setState({mode})
}
}
renderPill(name, mode) {
const isActive = this.state.mode === mode
if (isActive) {
return <li className="inline-block h-5 text-indigo-700 dark:text-indigo-500 font-bold border-b-2 border-indigo-700 dark:border-indigo-500">{name}</li>
} else {
return <li className="hover:text-indigo-600 cursor-pointer" onClick={this.setMode(mode)}>{name}</li>
}
}
render() {
const filters = this.props.query.filters
return (
<div className="stats-item">
<div className="bg-white dark:bg-gray-825 shadow-xl rounded p-4 relative" style={{height: '436px'}}>
<div className="w-full flex justify-between">
<h3 className="font-bold dark:text-gray-100">{labelFor[this.state.mode] || 'Page Visits'}</h3>
<ul className="flex font-medium text-xs text-gray-500 dark:text-gray-400 space-x-2">
{ this.renderPill('Top Pages', 'pages') }
{ this.renderPill('Entry Pages', 'entry-pages') }
{ this.renderPill('Exit Pages', 'exit-pages') }
</ul>
</div>
{ this.renderContent() }
</div>
</div>
)
}
}

@ -2,14 +2,14 @@ import React from 'react';
import { Link } from 'react-router-dom'
import FlipMove from 'react-flip-move';
import FadeIn from '../fade-in'
import Bar from './bar'
import MoreLink from './more-link'
import numberFormatter from '../number-formatter'
import { eventName } from '../query'
import * as api from '../api'
import FadeIn from '../../fade-in'
import Bar from '../bar'
import MoreLink from '../more-link'
import numberFormatter from '../../number-formatter'
import { eventName } from '../../query'
import * as api from '../../api'
export default class Pages extends React.Component {
export default class Visits extends React.Component {
constructor(props) {
super(props)
this.state = {loading: true}
@ -28,14 +28,8 @@ export default class Pages extends React.Component {
}
fetchPages() {
const {filters} = this.props.query
if (filters.source || filters.referrer) {
api.get(`/api/stats/${encodeURIComponent(this.props.site.domain)}/entry-pages`, this.props.query)
.then((res) => this.setState({loading: false, pages: res}))
} else {
api.get(`/api/stats/${encodeURIComponent(this.props.site.domain)}/pages`, this.props.query)
.then((res) => this.setState({loading: false, pages: res}))
}
api.get(`/api/stats/${encodeURIComponent(this.props.site.domain)}/pages`, this.props.query)
.then((res) => this.setState({loading: false, pages: res}))
}
renderPage(page) {
@ -64,15 +58,13 @@ export default class Pages extends React.Component {
const filters = this.props.query.filters
if (this.props.query.period === 'realtime') {
return 'Current visitors'
} else if (filters['source'] || filters['referrer']) {
return 'Entrances'
} else {
return 'Visitors'
}
}
renderList() {
if (this.state.pages.length > 0) {
if (this.state.pages && this.state.pages.length > 0) {
return (
<React.Fragment>
<div className="flex items-center mt-3 mb-2 justify-between text-gray-500 dark:text-gray-400 text-xs font-bold tracking-wide">
@ -90,31 +82,16 @@ export default class Pages extends React.Component {
}
}
title() {
const filters = this.props.query.filters
return filters['source'] || filters['referrer'] ? 'Entry Pages' : 'Top Pages'
}
renderContent() {
if (this.state.pages) {
return (
<React.Fragment>
<h3 className="font-bold dark:text-gray-100">{this.title()}</h3>
{ this.renderList() }
<MoreLink site={this.props.site} list={this.state.pages} endpoint="pages" />
</React.Fragment>
)
}
}
render() {
const { loading } = this.state;
return (
<div className="stats-item relative bg-white dark:bg-gray-825 shadow-xl rounded p-4" style={{height: '436px'}}>
{ this.state.loading && <div className="loading mt-44 mx-auto"><div></div></div> }
<FadeIn show={!this.state.loading}>
{ this.renderContent() }
<React.Fragment>
{ loading && <div className="loading mt-44 mx-auto"><div></div></div> }
<FadeIn show={!loading}>
{ this.renderList() }
</FadeIn>
</div>
{!loading && <MoreLink site={this.props.site} list={this.state.pages} endpoint="pages" />}
</React.Fragment>
)
}
}

@ -60,7 +60,7 @@ class AllSources extends React.Component {
}
renderList() {
if (this.state.referrers.length > 0) {
if (this.state.referrers && this.state.referrers.length > 0) {
return (
<React.Fragment>
<div className="flex items-center mt-3 mb-2 justify-between text-gray-500 text-xs font-bold tracking-wide">
@ -71,6 +71,7 @@ class AllSources extends React.Component {
<FlipMove>
{this.state.referrers.map(this.renderReferrer.bind(this))}
</FlipMove>
<MoreLink site={this.props.site} list={this.state.referrers} endpoint="sources" />
</React.Fragment>
)
} else {
@ -79,27 +80,24 @@ class AllSources extends React.Component {
}
renderContent() {
if (this.state.referrers) {
return (
<React.Fragment>
<div className="w-full flex justify-between">
<h3 className="font-bold dark:text-gray-100">Top sources</h3>
{ this.props.renderTabs() }
</div>
return (
<React.Fragment>
<div className="w-full flex justify-between">
<h3 className="font-bold dark:text-gray-100">Top sources</h3>
{ this.props.renderTabs() }
</div>
{ this.state.loading && <div className="loading mt-44 mx-auto"><div></div></div> }
<FadeIn show={!this.state.loading}>
{ this.renderList() }
<MoreLink site={this.props.site} list={this.state.referrers} endpoint="sources" />
</React.Fragment>
)
}
</FadeIn>
</React.Fragment>
)
}
render() {
return (
<div className="stats-item relative bg-white dark:bg-gray-825 shadow-xl rounded p-4" style={{height: '436px'}}>
{ this.state.loading && <div className="loading mt-44 mx-auto"><div></div></div> }
<FadeIn show={!this.state.loading}>
{ this.renderContent() }
</FadeIn>
</div>
)
}
@ -163,7 +161,7 @@ class UTMSources extends React.Component {
}
renderList() {
if (this.state.referrers.length > 0) {
if (this.state.referrers && this.state.referrers.length > 0) {
return (
<React.Fragment>
<div className="flex items-center mt-3 mb-2 justify-between text-gray-500 dark:text-gray-400 text-xs font-bold tracking-wide">
@ -174,6 +172,7 @@ class UTMSources extends React.Component {
<FlipMove>
{this.state.referrers.map(this.renderReferrer.bind(this))}
</FlipMove>
<MoreLink site={this.props.site} list={this.state.referrers} endpoint="sources" />
</React.Fragment>
)
} else {
@ -182,27 +181,24 @@ class UTMSources extends React.Component {
}
renderContent() {
if (this.state.referrers) {
return (
<React.Fragment>
<div className="w-full flex justify-between">
<h3 className="font-bold dark:text-gray-100">Top sources</h3>
{ this.props.renderTabs() }
</div>
return (
<React.Fragment>
<div className="w-full flex justify-between">
<h3 className="font-bold dark:text-gray-100">Top sources</h3>
{ this.props.renderTabs() }
</div>
{ this.state.loading && <div className="loading mt-44 mx-auto"><div></div></div> }
<FadeIn show={!this.state.loading}>
{ this.renderList() }
<MoreLink site={this.props.site} list={this.state.referrers} endpoint={UTM_TAGS[this.props.tab].endpoint} />
</React.Fragment>
)
}
</FadeIn>
</React.Fragment>
)
}
render() {
return (
<div className="stats-item relative bg-white dark:bg-gray-825 shadow-xl rounded p-4" style={{height: '436px'}}>
{ this.state.loading && <div className="loading mt-44 mx-auto"><div></div></div> }
<FadeIn show={!this.state.loading}>
{ this.renderContent() }
</FadeIn>
{ this.renderContent() }
</div>
)
}

@ -131,15 +131,19 @@ defmodule Plausible.Stats.Clickhouse do
end
def bounce_rate(site, query) do
q = base_session_query(site, query) |> apply_page_as_entry_page(site, query)
ClickhouseRepo.one(
from s in base_session_query(site, query),
from s in q,
select: fragment("round(sum(is_bounce * sign) / sum(sign) * 100)")
) || 0
end
def visit_duration(site, query) do
q = base_session_query(site, query) |> apply_page_as_entry_page(site, query)
ClickhouseRepo.one(
from s in base_session_query(site, query),
from s in q,
select: fragment("round(avg(duration * sign))")
) || 0
end
@ -147,15 +151,17 @@ defmodule Plausible.Stats.Clickhouse do
def total_pageviews(site, %Query{period: "realtime"} = query) do
query = %Query{query | period: "30m"}
q = base_session_query(site, query) |> apply_page_as_entry_page(site, query)
ClickhouseRepo.one(
from e in base_session_query(site, query),
from e in q,
select: fragment("sum(sign * pageviews)")
)
end
def total_pageviews(site, query) do
ClickhouseRepo.one(
from e in base_query(site, query),
from e in base_query_w_sessions(site, query),
select: fragment("count(*)")
)
end
@ -291,20 +297,34 @@ defmodule Plausible.Stats.Clickhouse do
end)
end
defp filter_converted_sessions(db_query, site, %Query{filters: %{"goal" => goal}} = query)
when is_binary(goal) do
converted_sessions =
from(e in base_query(site, query),
select: %{session_id: e.session_id}
)
defp filter_converted_sessions(db_query, site, query) do
goal = query.filters["goal"]
page = query.filters["page"]
from(s in db_query,
join: cs in subquery(converted_sessions),
on: s.session_id == cs.session_id
)
if is_binary(goal) || is_binary(page) do
converted_sessions =
from(e in base_query(site, query),
select: %{session_id: fragment("DISTINCT ?", e.session_id)}
)
from(s in db_query,
join: cs in subquery(converted_sessions),
on: s.session_id == cs.session_id
)
else
db_query
end
end
defp filter_converted_sessions(db_query, _site, _query), do: db_query
defp apply_page_as_entry_page(db_query, _site, query) do
page = query.filters["page"]
if is_binary(page) do
from(s in db_query, where: s.entry_page == ^page)
else
db_query
end
end
def utm_mediums(site, query, limit \\ 9, page \\ 1, show_noref \\ false) do
offset = (page - 1) * limit
@ -485,7 +505,7 @@ defmodule Plausible.Stats.Clickhouse do
)
end
def entry_pages(site, query, limit, page \\ 1, include) do
def entry_pages(site, query, limit, page \\ 1) do
offset = (page - 1) * limit
q =
@ -497,33 +517,72 @@ defmodule Plausible.Stats.Clickhouse do
offset: ^offset,
select: %{
name: s.entry_page,
count: fragment("uniq(?) as count", s.user_id)
count: fragment("uniq(?) as count", s.user_id),
entries: fragment("uniq(?) as entries", s.session_id),
visit_duration: fragment("avg(?) as visit_duration", s.duration)
}
)
|> filter_converted_sessions(site, query)
ClickhouseRepo.all(q)
end
def exit_pages(site, query, limit, page \\ 1) do
offset = (page - 1) * limit
q =
if query.filters["page"] do
page = query.filters["page"]
from(s in q, where: s.entry_page == ^page)
else
q
end
from(
s in base_session_query(site, query),
group_by: s.exit_page,
order_by: [desc: fragment("count")],
limit: ^limit,
offset: ^offset,
select: %{
name: s.exit_page,
count: fragment("uniq(?) as count", s.user_id),
exits: fragment("uniq(?) as exits", s.session_id)
}
)
|> filter_converted_sessions(site, query)
pages = ClickhouseRepo.all(q)
result = ClickhouseRepo.all(q)
if "bounce_rate" in include do
bounce_rates = bounce_rates_by_page_url(site, query)
Enum.map(pages, fn url -> Map.put(url, :bounce_rate, bounce_rates[url[:name]]) end)
if Enum.count(result) > 0 do
pages = Enum.map(result, fn r -> r[:name] end)
event_q =
from(e in base_query_w_session_based_pageviews(site, query),
group_by: e.pathname,
where: fragment("? IN tuple(?)", e.pathname, ^pages),
where: e.name == "pageview",
select: {
e.pathname,
fragment("count(*)")
}
)
total_pageviews = ClickhouseRepo.all(event_q) |> Enum.into(%{})
Enum.map(result, fn r ->
if Map.get(total_pageviews, r[:name]) do
exit_rate = r[:exits] / Map.get(total_pageviews, r[:name]) * 100
Map.put(r, :exit_rate, Float.floor(exit_rate))
else
Map.put(r, :exit_rate, nil)
end
end)
else
pages
result
end
end
def top_pages(site, %Query{period: "realtime"} = query, limit, page, _include) do
offset = (page - 1) * limit
q = base_session_query(site, query) |> apply_page_as_entry_page(site, query)
ClickhouseRepo.all(
from s in base_session_query(site, query),
from s in q,
group_by: s.exit_page,
order_by: [desc: fragment("count")],
limit: ^limit,
@ -540,7 +599,7 @@ defmodule Plausible.Stats.Clickhouse do
q =
from(
e in base_query(site, query),
e in base_query_w_sessions(site, query),
group_by: e.pathname,
order_by: [desc: fragment("count")],
limit: ^limit,
@ -563,8 +622,10 @@ defmodule Plausible.Stats.Clickhouse do
end
defp bounce_rates_by_page_url(site, query) do
q = base_session_query(site, query) |> apply_page_as_entry_page(site, query)
ClickhouseRepo.all(
from s in base_session_query(site, query),
from s in q,
group_by: s.entry_page,
order_by: [desc: fragment("total")],
limit: 100,
@ -989,6 +1050,22 @@ defmodule Plausible.Stats.Clickhouse do
sessions_q
end
sessions_q =
if query.filters["entry_page"] do
entry_page = query.filters["entry_page"]
from(s in sessions_q, where: s.entry_page == ^entry_page)
else
sessions_q
end
sessions_q =
if query.filters["exit_page"] do
exit_page = query.filters["exit_page"]
from(s in sessions_q, where: s.exit_page == ^exit_page)
else
sessions_q
end
q =
from(e in "events",
where: e.domain == ^site.domain,
@ -999,7 +1076,8 @@ defmodule Plausible.Stats.Clickhouse do
if query.filters["source"] || query.filters['referrer'] || query.filters["utm_medium"] ||
query.filters["utm_source"] || query.filters["utm_campaign"] || query.filters["screen"] ||
query.filters["browser"] || query.filters["browser_version"] || query.filters["os"] ||
query.filters["os_version"] || query.filters["country"] do
query.filters["os_version"] || query.filters["country"] || query.filters["entry_page"] ||
query.filters["exit_page"] do
from(
e in q,
join: sq in subquery(sessions_q),
@ -1038,6 +1116,37 @@ defmodule Plausible.Stats.Clickhouse do
end
end
defp base_query_w_session_based_pageviews(site, query) do
{first_datetime, last_datetime} = utc_boundaries(query, site.timezone)
sessions_q = base_session_query(site, query) |> filter_converted_sessions(site, query)
sessions_q =
from(s in sessions_q,
select: %{session_id: s.session_id}
)
q =
from(e in "events",
where: e.domain == ^site.domain,
where: e.timestamp >= ^first_datetime and e.timestamp < ^last_datetime
)
if query.filters["source"] || query.filters['referrer'] || query.filters["utm_medium"] ||
query.filters["utm_source"] || query.filters["utm_campaign"] || query.filters["screen"] ||
query.filters["browser"] || query.filters["browser_version"] || query.filters["os"] ||
query.filters["os_version"] || query.filters["country"] || query.filters["entry_page"] ||
query.filters["exit_page"] || query.filters["page"] || query.filters["goal"] do
from(
e in q,
join: sq in subquery(sessions_q),
on: e.session_id == sq.session_id
)
else
q
end
end
defp base_query_w_sessions(site, query) do
q = base_query_w_sessions_bare(site, query)
@ -1148,9 +1257,17 @@ defmodule Plausible.Stats.Clickhouse do
end
q =
if query.filters["page"] do
page = query.filters["page"]
from(s in q, where: s.entry_page == ^page)
if query.filters["entry_page"] do
entry_page = query.filters["entry_page"]
from(s in q, where: s.entry_page == ^entry_page)
else
q
end
q =
if query.filters["exit_page"] do
exit_page = query.filters["exit_page"]
from(s in q, where: s.exit_page == ^exit_page)
else
q
end
@ -1163,9 +1280,8 @@ defmodule Plausible.Stats.Clickhouse do
end
end
defp base_query(site, query) do
defp base_query_bare(site, query) do
{first_datetime, last_datetime} = utc_boundaries(query, site.timezone)
{goal_event, path} = event_name_for_goal(query)
q =
from(e in "events",
@ -1261,25 +1377,30 @@ defmodule Plausible.Stats.Clickhouse do
q
end
q =
if query.filters["props"] do
[{key, val}] = query.filters["props"] |> Enum.into([])
if val == "(none)" do
from(
e in q,
where: fragment("not has(meta.key, ?)", ^key)
)
else
from(
e in q,
inner_lateral_join: meta in fragment("meta as m"),
where: meta.key == ^key and meta.value == ^val
)
end
if query.filters["props"] do
[{key, val}] = query.filters["props"] |> Enum.into([])
if val == "(none)" do
from(
e in q,
where: fragment("not has(meta.key, ?)", ^key)
)
else
q
from(
e in q,
inner_lateral_join: meta in fragment("meta as m"),
where: meta.key == ^key and meta.value == ^val
)
end
else
q
end
end
defp base_query(site, query) do
q = base_query_bare(site, query)
{goal_event, path} = event_name_for_goal(query)
q =
if path do

@ -221,11 +221,19 @@ defmodule PlausibleWeb.Api.StatsController do
def entry_pages(conn, params) do
site = conn.assigns[:site]
query = Query.from(site.timezone, params)
include = if params["include"], do: String.split(params["include"], ","), else: []
limit = if params["limit"], do: String.to_integer(params["limit"])
page = if params["page"], do: String.to_integer(params["page"])
json(conn, Stats.entry_pages(site, query, limit || 9, page || 1, include))
json(conn, Stats.entry_pages(site, query, limit || 9, page || 1))
end
def exit_pages(conn, params) do
site = conn.assigns[:site]
query = Query.from(site.timezone, params)
limit = if params["limit"], do: String.to_integer(params["limit"])
page = if params["page"], do: String.to_integer(params["page"])
json(conn, Stats.exit_pages(site, query, limit || 9, page || 1))
end
def countries(conn, params) do

@ -58,6 +58,7 @@ defmodule PlausibleWeb.Router do
get "/:domain/goal/referrers/:referrer", StatsController, :referrer_drilldown_for_goal
get "/:domain/pages", StatsController, :pages
get "/:domain/entry-pages", StatsController, :entry_pages
get "/:domain/exit-pages", StatsController, :exit_pages
get "/:domain/countries", StatsController, :countries
get "/:domain/browsers", StatsController, :browsers
get "/:domain/browser-versions", StatsController, :browser_versions

@ -9,8 +9,8 @@ defmodule PlausibleWeb.Api.StatsController.BrowsersTest do
conn = get(conn, "/api/stats/#{site.domain}/browsers?period=day&date=2019-01-01")
assert json_response(conn, 200) == [
%{"name" => "Chrome", "count" => 2, "percentage" => 67},
%{"name" => "Firefox", "count" => 1, "percentage" => 33}
%{"name" => "Chrome", "count" => 3, "percentage" => 75},
%{"name" => "Firefox", "count" => 1, "percentage" => 25}
]
end
end

@ -17,14 +17,14 @@ defmodule PlausibleWeb.Api.StatsController.ConversionsTest do
"count" => 3,
"total_count" => 3,
"prop_names" => ["variant"],
"conversion_rate" => 50.0
"conversion_rate" => 42.9
},
%{
"name" => "Visit /register",
"count" => 2,
"total_count" => 2,
"prop_names" => nil,
"conversion_rate" => 33.3
"conversion_rate" => 28.6
}
]
end
@ -51,7 +51,7 @@ defmodule PlausibleWeb.Api.StatsController.ConversionsTest do
"count" => 3,
"total_count" => 3,
"prop_names" => ["variant"],
"conversion_rate" => 50.0
"conversion_rate" => 42.9
}
]
end
@ -74,8 +74,8 @@ defmodule PlausibleWeb.Api.StatsController.ConversionsTest do
)
assert json_response(conn, 200) == [
%{"count" => 2, "name" => "B", "total_count" => 2, "conversion_rate" => 33.3},
%{"count" => 1, "name" => "A", "total_count" => 1, "conversion_rate" => 16.7}
%{"count" => 2, "name" => "B", "total_count" => 2, "conversion_rate" => 28.6},
%{"count" => 1, "name" => "A", "total_count" => 1, "conversion_rate" => 14.3}
]
end
end

@ -13,13 +13,19 @@ defmodule PlausibleWeb.Api.StatsController.CountriesTest do
"name" => "EST",
"full_country_name" => "Estonia",
"count" => 2,
"percentage" => 67
"percentage" => 50
},
%{
"name" => "GBR",
"full_country_name" => "United Kingdom",
"count" => 1,
"percentage" => 33
"percentage" => 25
},
%{
"name" => "USA",
"full_country_name" => "United States",
"count" => 1,
"percentage" => 25
}
]
end

@ -22,7 +22,7 @@ defmodule PlausibleWeb.Api.StatsController.MainGraphTest do
zeroes = Stream.repeatedly(fn -> 0 end) |> Stream.take(22) |> Enum.into([])
assert Enum.count(plot) == 24
assert plot == [3] ++ zeroes ++ [3]
assert plot == [4] ++ zeroes ++ [3]
end
test "displays hourly stats in configured timezone", %{conn: conn, user: user} do
@ -45,7 +45,7 @@ defmodule PlausibleWeb.Api.StatsController.MainGraphTest do
assert %{"plot" => plot} = json_response(conn, 200)
assert Enum.count(plot) == 31
assert List.first(plot) == 6
assert List.first(plot) == 7
assert List.last(plot) == 1
end
@ -83,14 +83,14 @@ defmodule PlausibleWeb.Api.StatsController.MainGraphTest do
conn = get(conn, "/api/stats/#{site.domain}/main-graph?period=day&date=2019-01-01")
res = json_response(conn, 200)
assert %{"name" => "Unique visitors", "count" => 6, "change" => 100} in res["top_stats"]
assert %{"name" => "Unique visitors", "count" => 7, "change" => 100} in res["top_stats"]
end
test "counts total pageviews", %{conn: conn, site: site} do
conn = get(conn, "/api/stats/#{site.domain}/main-graph?period=day&date=2019-01-01")
res = json_response(conn, 200)
assert %{"name" => "Total pageviews", "count" => 6, "change" => 100} in res["top_stats"]
assert %{"name" => "Total pageviews", "count" => 7, "change" => 100} in res["top_stats"]
end
test "calculates bounce rate", %{conn: conn, site: site} do
@ -121,7 +121,7 @@ defmodule PlausibleWeb.Api.StatsController.MainGraphTest do
)
res = json_response(conn, 200)
assert %{"name" => "Unique visitors", "count" => 6, "change" => 100} in res["top_stats"]
assert %{"name" => "Unique visitors", "count" => 7, "change" => 100} in res["top_stats"]
end
test "returns converted visitors", %{conn: conn, site: site} do
@ -148,7 +148,7 @@ defmodule PlausibleWeb.Api.StatsController.MainGraphTest do
res = json_response(conn, 200)
assert %{"name" => "Conversion rate", "percentage" => 50.0, "change" => 100} in res[
assert %{"name" => "Conversion rate", "percentage" => 42.9, "change" => 100} in res[
"top_stats"
]
end

@ -9,8 +9,8 @@ defmodule PlausibleWeb.Api.StatsController.OperatingSystemsTest do
conn = get(conn, "/api/stats/#{site.domain}/operating-systems?period=day&date=2019-01-01")
assert json_response(conn, 200) == [
%{"name" => "Mac", "count" => 2, "percentage" => 67},
%{"name" => "Android", "count" => 1, "percentage" => 33}
%{"name" => "Mac", "count" => 3, "percentage" => 75},
%{"name" => "Android", "count" => 1, "percentage" => 25}
]
end
end

@ -9,7 +9,7 @@ defmodule PlausibleWeb.Api.StatsController.PagesTest do
conn = get(conn, "/api/stats/#{site.domain}/pages?period=day&date=2019-01-01")
assert json_response(conn, 200) == [
%{"count" => 2, "pageviews" => 2, "name" => "/"},
%{"count" => 3, "pageviews" => 3, "name" => "/"},
%{"count" => 2, "pageviews" => 2, "name" => "/register"},
%{"count" => 1, "pageviews" => 1, "name" => "/contact"},
%{"count" => 1, "pageviews" => 1, "name" => "/irrelevant"}
@ -26,8 +26,8 @@ defmodule PlausibleWeb.Api.StatsController.PagesTest do
assert json_response(conn, 200) == [
%{
"bounce_rate" => 33.0,
"count" => 2,
"pageviews" => 2,
"count" => 3,
"pageviews" => 3,
"name" => "/"
},
%{
@ -68,24 +68,42 @@ defmodule PlausibleWeb.Api.StatsController.PagesTest do
conn = get(conn, "/api/stats/#{site.domain}/entry-pages?period=day&date=2019-01-01")
assert json_response(conn, 200) == [
%{"count" => 3, "name" => "/"}
%{
"count" => 3,
"entries" => 3,
"name" => "/",
"visit_duration" => 66.66666666666667
}
]
end
test "calculates bounce rate for entry pages", %{conn: conn, site: site} do
test "calculates visit duration for entry pages", %{conn: conn, site: site} do
conn =
get(
conn,
"/api/stats/#{site.domain}/entry-pages?period=day&date=2019-01-01&include=bounce_rate"
"/api/stats/#{site.domain}/entry-pages?period=day&date=2019-01-01"
)
assert json_response(conn, 200) == [
%{
"bounce_rate" => 33.0,
"visit_duration" => 66.66666666666667,
"count" => 3,
"entries" => 3,
"name" => "/"
}
]
end
end
describe "GET /api/stats/:domain/exit-pages" do
setup [:create_user, :log_in, :create_site]
test "returns top exit pages by visitors", %{conn: conn, site: site} do
conn = get(conn, "/api/stats/#{site.domain}/exit-pages?period=day&date=2019-01-01")
assert json_response(conn, 200) == [
%{"count" => 3, "exits" => 3, "name" => "/", "exit_rate" => 100.0}
]
end
end
end

@ -9,8 +9,9 @@ defmodule PlausibleWeb.Api.StatsController.ScreenSizesTest do
conn = get(conn, "/api/stats/#{site.domain}/screen-sizes?period=day&date=2019-01-01")
assert json_response(conn, 200) == [
%{"name" => "Desktop", "count" => 2, "percentage" => 67},
%{"name" => "Mobile", "count" => 1, "percentage" => 33}
%{"name" => "Desktop", "count" => 2, "percentage" => 50},
%{"name" => "Laptop", "count" => 1, "percentage" => 25},
%{"name" => "Mobile", "count" => 1, "percentage" => 25}
]
end
end

@ -33,6 +33,20 @@ defmodule Plausible.Test.ClickhouseSetup do
referrer: "10words.com/page2",
timestamp: ~N[2019-01-01 00:00:00]
},
%{
name: "pageview",
domain: "test-site.com",
pathname: "/",
country_code: "US",
browser: "Chrome",
browser_version: "79.0",
operating_system: "Mac",
operating_system_version: "10.16",
screen_size: "Laptop",
referrer_source: "",
referrer: "",
timestamp: ~N[2019-01-01 00:00:00]
},
%{
name: "pageview",
domain: "test-site.com",

Loading…
Cancel
Save