plausible/analytics
1
1
Fork 0
mirror of https://github.com/plausible/analytics.git synced 2024-11-24 04:32:57 +03:00
Code Issues Packages Projects Releases Wiki Activity
e4b1adc4dd
analytics/Plausible.Stats.Fragments.html
vinibrsl e4b1adc4dd deploy: 7036332db2
2023-11-08 13:25:09 +00:00

493 lines
15 KiB
HTML
Raw Blame 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.Fragments — 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-241F8C85.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/fragments.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.Fragments</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="#bounce_rate/0" translate="no">bounce_rate()</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#coalesce_string/2" translate="no">coalesce_string(fieldA, fieldB)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#sample_percent/0" translate="no">sample_percent()</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#to_timezone/2" translate="no">to_timezone(date, timezone)</a>
</div>
<div class="summary-synopsis"><p>Converts time or date and time to the specified timezone.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#total/0" translate="no">total()</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#uniq/1" translate="no">uniq(user_id)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#visit_duration/0" translate="no">visit_duration()</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#weekstart_not_before/2" translate="no">weekstart_not_before(date, not_before)</a>
</div>
<div class="summary-synopsis"><p>Returns the weekstart for <code class="inline">date</code>. If the weekstart is before the <code class="inline">not_before</code>
boundary, <code class="inline">not_before</code> is returned.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#weekstart_not_before/3" translate="no">weekstart_not_before(date, not_before, timezone)</a>
</div>
<div class="summary-synopsis"><p>Same as Plausible.Stats.Fragments.weekstart_not_before/2 but converts dates to
the specified timezone.</p></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="bounce_rate/0">
<div class="detail-header">
<a href="#bounce_rate/0" class="detail-link" title="Link to this macro">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this macro</span>
</a>
<h1 class="signature" translate="no">bounce_rate()</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/stats/fragments.ex#L20" 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>
<span class="note">(macro)</span>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="coalesce_string/2">
<div class="detail-header">
<a href="#coalesce_string/2" class="detail-link" title="Link to this macro">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this macro</span>
</a>
<h1 class="signature" translate="no">coalesce_string(fieldA, fieldB)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/stats/fragments.ex#L32" 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>
<span class="note">(macro)</span>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="sample_percent/0">
<div class="detail-header">
<a href="#sample_percent/0" class="detail-link" title="Link to this macro">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this macro</span>
</a>
<h1 class="signature" translate="no">sample_percent()</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/stats/fragments.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>
<span class="note">(macro)</span>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="to_timezone/2">
<div class="detail-header">
<a href="#to_timezone/2" class="detail-link" title="Link to this macro">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this macro</span>
</a>
<h1 class="signature" translate="no">to_timezone(date, timezone)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/stats/fragments.ex#L43" 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>
<span class="note">(macro)</span>
</div>
<section class="docstring">
<p>Converts time or date and time to the specified timezone.</p><p>Reference: <a href="https://clickhouse.com/docs/en/sql-reference/functions/date-time-functions/#totimezone">https://clickhouse.com/docs/en/sql-reference/functions/date-time-functions/#totimezone</a></p>
</section>
</section>
<section class="detail" id="total/0">
<div class="detail-header">
<a href="#total/0" class="detail-link" title="Link to this macro">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this macro</span>
</a>
<h1 class="signature" translate="no">total()</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/stats/fragments.ex#L8" 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>
<span class="note">(macro)</span>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="uniq/1">
<div class="detail-header">
<a href="#uniq/1" class="detail-link" title="Link to this macro">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this macro</span>
</a>
<h1 class="signature" translate="no">uniq(user_id)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/stats/fragments.ex#L2" 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>
<span class="note">(macro)</span>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="visit_duration/0">
<div class="detail-header">
<a href="#visit_duration/0" class="detail-link" title="Link to this macro">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this macro</span>
</a>
<h1 class="signature" translate="no">visit_duration()</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/stats/fragments.ex#L26" 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>
<span class="note">(macro)</span>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="weekstart_not_before/2">
<div class="detail-header">
<a href="#weekstart_not_before/2" class="detail-link" title="Link to this macro">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this macro</span>
</a>
<h1 class="signature" translate="no">weekstart_not_before(date, not_before)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/stats/fragments.ex#L75" 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>
<span class="note">(macro)</span>
</div>
<section class="docstring">
<p>Returns the weekstart for <code class="inline">date</code>. If the weekstart is before the <code class="inline">not_before</code>
boundary, <code class="inline">not_before</code> is returned.</p><h2 id="weekstart_not_before/2-examples" class="section-heading">
<a href="#weekstart_not_before/2-examples">
<i class="ri-link-m" aria-hidden="true"></i>
Examples
</a>
</h2>
<p>In this pseudo-code example, the fragment returns the weekstart. The
<code class="inline">not_before</code> boundary is set to the past Saturday, which is before the
weekstart, therefore the cap does not apply.</p><p> iex&gt; this_wednesday = ~D[2022-11-09]
...&gt; past_saturday = ~D[2022-11-05]
...&gt; weekstart_not_before(this_wednesday, past_saturday)
~D[2022-11-07]</p><p>In this other example, the fragment returns Tuesday and not the weekstart.
The <code class="inline">not_before</code> boundary is set to Tuesday, which is past the weekstart,
therefore the cap applies.</p><p> iex&gt; this_wednesday = ~D[2022-11-09]
...&gt; this_tuesday = ~D[2022-11-08]
...&gt; weekstart_not_before(this_wednesday, this_tuesday)
~D[2022-11-08]</p>
</section>
</section>
<section class="detail" id="weekstart_not_before/3">
<div class="detail-header">
<a href="#weekstart_not_before/3" class="detail-link" title="Link to this macro">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this macro</span>
</a>
<h1 class="signature" translate="no">weekstart_not_before(date, not_before, timezone)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/stats/fragments.ex#L91" 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>
<span class="note">(macro)</span>
</div>
<section class="docstring">
<p>Same as Plausible.Stats.Fragments.weekstart_not_before/2 but converts dates to
the specified timezone.</p>
</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>
Reference in New Issue View Git Blame Copy Permalink