mirror of
https://github.com/plausible/analytics.git
synced 2024-11-23 11:12:15 +03:00
367 lines
14 KiB
HTML
367 lines
14 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="x-ua-compatible" content="ie=edge">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<meta name="generator" content="ExDoc v0.31.1">
|
|
<meta name="project" content="Plausible v0.0.1">
|
|
|
|
|
|
<title>PlausibleWeb.StatsController — Plausible v0.0.1</title>
|
|
<link rel="stylesheet" href="dist/html-elixir-FM2CSD74.css" />
|
|
|
|
|
|
<script src="dist/handlebars.runtime-NWIB6V2M.js"></script>
|
|
<script src="dist/handlebars.templates-43PMFBC7.js"></script>
|
|
<script src="dist/sidebar_items-103B8C4F.js"></script>
|
|
|
|
<script src="docs_config.js"></script>
|
|
|
|
<script async src="dist/html-L4O5OK2K.js"></script>
|
|
|
|
|
|
</head>
|
|
<body data-type="modules" class="page-module">
|
|
<script>
|
|
|
|
try {
|
|
var settings = JSON.parse(localStorage.getItem('ex_doc:settings') || '{}');
|
|
|
|
if (settings.theme === 'dark' ||
|
|
((settings.theme === 'system' || settings.theme == null) &&
|
|
window.matchMedia('(prefers-color-scheme: dark)').matches)
|
|
) {
|
|
document.body.classList.add('dark')
|
|
}
|
|
} catch (error) { }
|
|
</script>
|
|
|
|
<div class="main">
|
|
|
|
<button id="sidebar-menu" class="sidebar-button sidebar-toggle" aria-label="toggle sidebar" aria-controls="sidebar">
|
|
<i class="ri-menu-line ri-lg" title="Collapse/expand sidebar"></i>
|
|
</button>
|
|
|
|
<div class="background-layer"></div>
|
|
|
|
<nav id="sidebar" class="sidebar">
|
|
|
|
<div class="sidebar-header">
|
|
<div class="sidebar-projectInfo">
|
|
|
|
<a href="readme.html" class="sidebar-projectImage">
|
|
<img src="assets/logo.png" alt="Plausible" />
|
|
</a>
|
|
|
|
<div>
|
|
<a href="readme.html" class="sidebar-projectName" translate="no">
|
|
Plausible
|
|
</a>
|
|
<div class="sidebar-projectVersion" translate="no">
|
|
v0.0.1
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<ul id="sidebar-listNav" class="sidebar-listNav" role="tablist">
|
|
<li>
|
|
<button id="extras-list-tab-button" role="tab" data-type="extras" aria-controls="extras-tab-panel" aria-selected="true" tabindex="0">
|
|
Pages
|
|
</button>
|
|
</li>
|
|
|
|
<li>
|
|
<button id="modules-list-tab-button" role="tab" data-type="modules" aria-controls="modules-tab-panel" aria-selected="false" tabindex="-1">
|
|
Modules
|
|
</button>
|
|
</li>
|
|
|
|
|
|
<li>
|
|
<button id="tasks-list-tab-button" role="tab" data-type="tasks" aria-controls="tasks-tab-panel" aria-selected="false" tabindex="-1">
|
|
<span translate="no">Mix</span> Tasks
|
|
</button>
|
|
</li>
|
|
|
|
</ul>
|
|
</div>
|
|
|
|
<div id="extras-tab-panel" class="sidebar-tabpanel" role="tabpanel" aria-labelledby="extras-list-tab-button">
|
|
<ul id="extras-full-list" class="full-list"></ul>
|
|
</div>
|
|
|
|
<div id="modules-tab-panel" class="sidebar-tabpanel" role="tabpanel" aria-labelledby="modules-list-tab-button" hidden>
|
|
<ul id="modules-full-list" class="full-list"></ul>
|
|
</div>
|
|
|
|
|
|
<div id="tasks-tab-panel" class="sidebar-tabpanel" role="tabpanel" aria-labelledby="tasks-list-tab-button" hidden>
|
|
<ul id="tasks-full-list" class="full-list"></ul>
|
|
</div>
|
|
|
|
</nav>
|
|
|
|
<main class="content">
|
|
<output role="status" id="toast"></output>
|
|
<div class="content-outer">
|
|
<div id="content" class="content-inner">
|
|
<div class="top-search">
|
|
<div class="search-settings">
|
|
<form class="search-bar" action="search.html">
|
|
<label class="search-label">
|
|
<span class="sr-only">Search documentation of Plausible</span>
|
|
<input name="q" type="text" class="search-input" placeholder="Search Documentation (press /)" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" />
|
|
</label>
|
|
<button type="submit" class="search-button" aria-label="Submit Search">
|
|
<i class="ri-search-2-line ri-lg" aria-hidden="true" title="Submit search"></i>
|
|
</button>
|
|
<button type="button" tabindex="-1" class="search-close-button" aria-hidden="true">
|
|
<i class="ri-close-line ri-lg" title="Cancel search"></i>
|
|
</button>
|
|
</form>
|
|
<div class="autocomplete">
|
|
</div>
|
|
<button class="icon-settings display-settings">
|
|
<i class="ri-settings-3-line"></i>
|
|
<span class="sr-only">Settings</span>
|
|
</button>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<h1>
|
|
|
|
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/controllers/stats_controller.ex#L1" title="View Source" class="icon-action" rel="help">
|
|
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
|
|
<span class="sr-only">View Source</span>
|
|
</a>
|
|
|
|
<span translate="no">PlausibleWeb.StatsController</span>
|
|
<small class="app-vsn" translate="no">(Plausible v0.0.1)</small>
|
|
|
|
</h1>
|
|
|
|
|
|
<section id="moduledoc">
|
|
<p>This controller is responsible for rendering stats dashboards.</p><p>The stats dashboards are currently the only part of the app that uses client-side
|
|
rendering. Since the dashboards are heavily interactive, they are built with React
|
|
which is an appropriate choice for highly interactive browser UIs.</p><div class="mermaid">sequenceDiagram
|
|
Browser->>StatsController: GET /mydomain.com
|
|
StatsController-->>Browser: StatsView.render("stats.html")
|
|
Note left of Browser: ReactDom.render(Dashboard)
|
|
|
|
Browser -) Api.StatsController: GET /api/stats/mydomain.com/top-stats
|
|
Api.StatsController --) Browser: {"top_stats": [...]}
|
|
Note left of Browser: TopStats.render()
|
|
|
|
Browser -) Api.StatsController: GET /api/stats/mydomain.com/main-graph
|
|
Api.StatsController --) Browser: [{"plot": [...], "labels": [...]}, ...]
|
|
Note left of Browser: VisitorGraph.render()
|
|
|
|
Browser -) Api.StatsController: GET /api/stats/mydomain.com/sources
|
|
Api.StatsController --) Browser: [{"name": "Google", "visitors": 292150}, ...]
|
|
Note left of Browser: Sources.render()
|
|
|
|
Note over Browser,StatsController: And so on, for all reports in the viewport</div><p>This reasoning for this sequence is as follows:</p><ol><li>First paint is fast because it doesn't do any data aggregation yet - good UX</li><li>The basic structure of the dashboard is rendered with spinners before reports are ready - good UX</li><li>Rendering on the frontend allows for maximum interactivity. Re-rendering and re-fetching can be as granular as needed.</li><li>Routing on the frontend allows the user to navigate the dashboard without reloading the page and losing context</li><li>Rendering on the frontend allows caching results in the browser to reduce pressure on backends and storage
|
|
3.1 No client-side caching has been implemented yet. This is still theoretical. See <a href="https://github.com/plausible/analytics/discussions/1278">https://github.com/plausible/analytics/discussions/1278</a>
|
|
3.2 This is a big potential opportunity, because analytics data is mostly immutable. Clients can cache all historical data.</li><li>Since frontend rendering & navigation is harder to build and maintain than regular server-rendered HTML, we don't use SPA-style rendering anywhere else
|
|
.The only place currently where the benefits outweigh the costs is the dashboard.</li></ol>
|
|
</section>
|
|
|
|
|
|
<section id="summary" class="details-list">
|
|
<h1 class="section-heading">
|
|
<a class="hover-link" href="#summary">
|
|
<i class="ri-link-m" aria-hidden="true"></i>
|
|
</a>
|
|
<span class="text">Summary</span>
|
|
</h1>
|
|
<div class="summary-functions summary">
|
|
<h2>
|
|
<a href="#functions">Functions</a>
|
|
</h2>
|
|
|
|
<div class="summary-row">
|
|
<div class="summary-signature">
|
|
<a href="#authenticate_shared_link/2" translate="no">authenticate_shared_link(conn, map)</a>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="summary-row">
|
|
<div class="summary-signature">
|
|
<a href="#csv_export/2" translate="no">csv_export(conn, params)</a>
|
|
|
|
</div>
|
|
|
|
<div class="summary-synopsis"><p>The export is limited to 300 entries for other reports and 100 entries for pages because bigger result sets
|
|
start causing failures. Since we request data like time on page or bounce_rate for pages in a separate query
|
|
using the IN filter, it causes the requests to balloon in payload size.</p></div>
|
|
|
|
</div>
|
|
|
|
<div class="summary-row">
|
|
<div class="summary-signature">
|
|
<a href="#shared_link/2" translate="no">shared_link(conn, arg2)</a>
|
|
|
|
</div>
|
|
|
|
<div class="summary-synopsis"><p> Authorizes and renders a shared link</p></div>
|
|
|
|
</div>
|
|
|
|
<div class="summary-row">
|
|
<div class="summary-signature">
|
|
<a href="#stats/2" translate="no">stats(conn, params)</a>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</section>
|
|
|
|
|
|
<section id="functions" class="details-list">
|
|
<h1 class="section-heading">
|
|
<a class="hover-link" href="#functions">
|
|
<i class="ri-link-m" aria-hidden="true"></i>
|
|
</a>
|
|
<span class="text">Functions</span>
|
|
</h1>
|
|
<div class="functions-list">
|
|
<section class="detail" id="authenticate_shared_link/2">
|
|
|
|
<div class="detail-header">
|
|
<a href="#authenticate_shared_link/2" class="detail-link" title="Link to this function">
|
|
<i class="ri-link-m" aria-hidden="true"></i>
|
|
<span class="sr-only">Link to this function</span>
|
|
</a>
|
|
<h1 class="signature" translate="no">authenticate_shared_link(conn, map)</h1>
|
|
|
|
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/controllers/stats_controller.ex#L302" class="icon-action" rel="help" title="View Source">
|
|
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
|
|
<span class="sr-only">View Source</span>
|
|
</a>
|
|
|
|
|
|
</div>
|
|
|
|
<section class="docstring">
|
|
|
|
|
|
</section>
|
|
</section>
|
|
<section class="detail" id="csv_export/2">
|
|
|
|
<div class="detail-header">
|
|
<a href="#csv_export/2" class="detail-link" title="Link to this function">
|
|
<i class="ri-link-m" aria-hidden="true"></i>
|
|
<span class="sr-only">Link to this function</span>
|
|
</a>
|
|
<h1 class="signature" translate="no">csv_export(conn, params)</h1>
|
|
|
|
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/controllers/stats_controller.ex#L112" class="icon-action" rel="help" title="View Source">
|
|
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
|
|
<span class="sr-only">View Source</span>
|
|
</a>
|
|
|
|
|
|
</div>
|
|
|
|
<section class="docstring">
|
|
|
|
<p>The export is limited to 300 entries for other reports and 100 entries for pages because bigger result sets
|
|
start causing failures. Since we request data like time on page or bounce_rate for pages in a separate query
|
|
using the IN filter, it causes the requests to balloon in payload size.</p>
|
|
</section>
|
|
</section>
|
|
<section class="detail" id="shared_link/2">
|
|
|
|
<div class="detail-header">
|
|
<a href="#shared_link/2" class="detail-link" title="Link to this function">
|
|
<i class="ri-link-m" aria-hidden="true"></i>
|
|
<span class="sr-only">Link to this function</span>
|
|
</a>
|
|
<h1 class="signature" translate="no">shared_link(conn, arg2)</h1>
|
|
|
|
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/controllers/stats_controller.ex#L228" class="icon-action" rel="help" title="View Source">
|
|
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
|
|
<span class="sr-only">View Source</span>
|
|
</a>
|
|
|
|
|
|
</div>
|
|
|
|
<section class="docstring">
|
|
|
|
<p> Authorizes and renders a shared link:</p><ol><li><p>Shared link with no password protection: needs to just make sure the shared link entry is still
|
|
in our database. This check makes sure shared link access can be revoked by the site admins. If the
|
|
shared link exists, render it directly.</p></li><li><p>Shared link with password protection: Same checks as without the password, but an extra step is taken to
|
|
protect the page with a password. When the user passes the password challenge, a cookie is set with Plausible.Auth.Token.sign_shared_link().
|
|
The cookie allows the user to access the dashboard for 24 hours without entering the password again.</p></li></ol><p> ### Backwards compatibility</p><p> The URL format for shared links was changed in <a href="https://github.com/plausible/analytics/pull/752">this pull request</a> in order
|
|
to make the URLs easier to bookmark. The old format is supported along with the new in order to not break old links.</p><p> See: <a href="https://plausible.io/docs/shared-links">https://plausible.io/docs/shared-links</a></p>
|
|
</section>
|
|
</section>
|
|
<section class="detail" id="stats/2">
|
|
|
|
<div class="detail-header">
|
|
<a href="#stats/2" class="detail-link" title="Link to this function">
|
|
<i class="ri-link-m" aria-hidden="true"></i>
|
|
<span class="sr-only">Link to this function</span>
|
|
</a>
|
|
<h1 class="signature" translate="no">stats(conn, params)</h1>
|
|
|
|
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/controllers/stats_controller.ex#L53" class="icon-action" rel="help" title="View Source">
|
|
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
|
|
<span class="sr-only">View Source</span>
|
|
</a>
|
|
|
|
|
|
</div>
|
|
|
|
<section class="docstring">
|
|
|
|
|
|
</section>
|
|
</section>
|
|
|
|
</div>
|
|
</section>
|
|
|
|
<footer class="footer">
|
|
<p>
|
|
|
|
<span class="line">
|
|
<button class="a-main footer-button display-quick-switch" title="Search HexDocs packages">
|
|
Search HexDocs
|
|
</button>
|
|
|
|
<a href="Plausible.epub" title="ePub version">
|
|
Download ePub version
|
|
</a>
|
|
|
|
</span>
|
|
</p>
|
|
|
|
<p class="built-using">
|
|
Built using
|
|
<a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" target="_blank" rel="help noopener" translate="no">ExDoc</a> (v0.31.1) for the
|
|
|
|
<a href="https://elixir-lang.org" title="Elixir" target="_blank" translate="no">Elixir programming language</a>
|
|
|
|
</p>
|
|
</footer>
|
|
</div>
|
|
</div>
|
|
</main>
|
|
</div>
|
|
|
|
<script src="https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js"></script>
|
|
<script>mermaid.initialize({startOnLoad: true})</script>
|
|
|
|
</body>
|
|
</html>
|