analytics/Plausible.Stats.Clickhouse.html

445 lines
14 KiB
HTML
Raw Normal View History

<!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.30.3">
<meta name="project" content="Plausible v0.0.1">
<title>Plausible.Stats.Clickhouse — Plausible v0.0.1</title>
<link rel="stylesheet" href="dist/html-elixir-P5GXSCHE.css" />
<script src="dist/handlebars.runtime-NWIB6V2M.js"></script>
<script src="dist/handlebars.templates-NBND3S2D.js"></script>
<script src="dist/sidebar_items-742B23D6.js"></script>
<script src="docs_config.js"></script>
<script async src="dist/html-CGDDOCMI.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 class="sidebar-button sidebar-toggle" aria-label="toggle sidebar">
<i class="ri-menu-line ri-lg" title="Collapse/expand sidebar"></i>
</button>
<section class="sidebar">
<form class="sidebar-search" action="search.html">
<button type="submit" class="search-button" aria-label="Submit Search">
<i class="ri-search-2-line" aria-hidden="true" title="Submit search"></i>
</button>
<button type="button" tabindex="-1" class="search-close-button" aria-label="Cancel Search">
<i class="ri-close-line ri-lg" aria-hidden="true" title="Cancel search"></i>
</button>
<label class="search-label">
<p class="sr-only">Search</p>
<input name="q" type="text" class="search-input" placeholder="Search..." aria-label="Input your search terms" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" />
</label>
</form>
<div class="autocomplete">
<div class="autocomplete-results">
</div>
</div>
<div class="sidebar-header">
<a href="readme.html">
<img src="assets/logo.png" alt="Plausible" class="sidebar-projectImage">
</a>
<div class="sidebar-projectDetails">
<a href="readme.html" class="sidebar-projectName" translate="no">
Plausible
</a>
<div class="sidebar-projectVersion" translate="no">
v0.0.1
</div>
</div>
<ul class="sidebar-listNav">
<li><a id="extras-list-link" href="#full-list">Pages</a></li>
<li><a id="modules-list-link" href="#full-list">Modules</a></li>
<li><a id="tasks-list-link" href="#full-list"><span translate="no">Mix</span> Tasks</a></li>
</ul>
</div>
<div class="gradient"></div>
<ul id="full-list"></ul>
</section>
<section class="content">
<output role="status" id="toast"></output>
<div class="content-outer">
<div id="content" class="content-inner">
<h1>
<button class="icon-action display-settings">
<i class="ri-settings-3-line"></i>
<span class="sr-only">Settings</span>
</button>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/stats/clickhouse.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">Plausible.Stats.Clickhouse</span>
<small class="app-vsn" translate="no">(Plausible v0.0.1)</small>
</h1>
<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>
Summary
</a>
</h1>
<div class="summary-functions summary">
<h2>
<a href="#functions">Functions</a>
</h2>
<div class="summary-row">
<div class="summary-signature">
<a href="#current_visitors/2" translate="no">current_visitors(site, query)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#empty_24h_visitors_hourly_intervals/2" translate="no">empty_24h_visitors_hourly_intervals(sites, now \\ NaiveDateTime.utc_now())</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#has_pageviews?/1" translate="no">has_pageviews?(site)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#imported_pageview_count/1" translate="no">imported_pageview_count(site)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#last_24h_visitors_hourly_intervals/2" translate="no">last_24h_visitors_hourly_intervals(sites, now \\ NaiveDateTime.utc_now())</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#pageview_start_date_local/1" translate="no">pageview_start_date_local(site)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#top_sources/6" translate="no">top_sources(site, query, limit, page, show_noref \\ false, include_details)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#usage_breakdown/2" translate="no">usage_breakdown(domains, date_range)</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>
Functions
</a>
</h1>
<div class="functions-list">
<section class="detail" id="current_visitors/2">
<div class="detail-header">
<a href="#current_visitors/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">current_visitors(site, query)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/stats/clickhouse.ex#L172" 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="empty_24h_visitors_hourly_intervals/2">
<span id="empty_24h_visitors_hourly_intervals/1"></span>
<div class="detail-header">
<a href="#empty_24h_visitors_hourly_intervals/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">empty_24h_visitors_hourly_intervals(sites, now \\ NaiveDateTime.utc_now())</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/stats/clickhouse.ex#L193" 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">
<div class="specs">
<pre translate="no"><span class="attribute">@spec</span> empty_24h_visitors_hourly_intervals([<a href="Plausible.Site.html#t:t/0">Plausible.Site.t</a>()], <a href="https://hexdocs.pm/elixir/NaiveDateTime.html#t:t/0">NaiveDateTime.t</a>()) ::
<a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">map</a>()</pre>
</div>
</section>
</section>
<section class="detail" id="has_pageviews?/1">
<div class="detail-header">
<a href="#has_pageviews?/1" 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">has_pageviews?(site)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/stats/clickhouse.ex#L180" 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="imported_pageview_count/1">
<div class="detail-header">
<a href="#imported_pageview_count/1" 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">imported_pageview_count(site)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/stats/clickhouse.ex#L36" 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="last_24h_visitors_hourly_intervals/2">
<span id="last_24h_visitors_hourly_intervals/1"></span>
<div class="detail-header">
<a href="#last_24h_visitors_hourly_intervals/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">last_24h_visitors_hourly_intervals(sites, now \\ NaiveDateTime.utc_now())</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/stats/clickhouse.ex#L207" 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">
<div class="specs">
<pre translate="no"><span class="attribute">@spec</span> last_24h_visitors_hourly_intervals([<a href="Plausible.Site.html#t:t/0">Plausible.Site.t</a>()], <a href="https://hexdocs.pm/elixir/NaiveDateTime.html#t:t/0">NaiveDateTime.t</a>()) ::
<a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">map</a>()</pre>
</div>
</section>
</section>
<section class="detail" id="pageview_start_date_local/1">
<div class="detail-header">
<a href="#pageview_start_date_local/1" 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">pageview_start_date_local(site)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/stats/clickhouse.ex#L14" 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">
<div class="specs">
<pre translate="no"><span class="attribute">@spec</span> pageview_start_date_local(<a href="Plausible.Site.html#t:t/0">Plausible.Site.t</a>()) :: <a href="https://hexdocs.pm/elixir/Date.html#t:t/0">Date.t</a>() | nil</pre>
</div>
</section>
</section>
<section class="detail" id="top_sources/6">
<span id="top_sources/5"></span>
<div class="detail-header">
<a href="#top_sources/6" 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">top_sources(site, query, limit, page, show_noref \\ false, include_details)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/stats/clickhouse.ex#L87" 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="usage_breakdown/2">
<div class="detail-header">
<a href="#usage_breakdown/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">usage_breakdown(domains, date_range)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/stats/clickhouse.ex#L45" 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.30.3) for the
<a href="https://elixir-lang.org" title="Elixir" target="_blank" translate="no">Elixir programming language</a>
</p>
</footer>
</div>
</div>
</section>
</div>
<script src="https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js"></script>
<script>mermaid.initialize({startOnLoad: true})</script>
</body>
</html>