<!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.Util — 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-97E28490.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/util.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.Util</span> <small class="app-vsn" translate="no">(Plausible v0.0.1)</small> </h1> <section id="moduledoc"> <p>Utilities for modifying stat results</p> </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> 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="#cast_revenue_metrics_to_money/2" translate="no">cast_revenue_metrics_to_money(results, revenue_goals)</a> </div> </div> <div class="summary-row"> <div class="summary-signature"> <a href="#get_revenue_tracking_currency/3" translate="no">get_revenue_tracking_currency(site, query, metrics)</a> </div> <div class="summary-synopsis"><p>Returns the common currency for the goal filters in a query. If there are no goal filters, or multiple currencies, <code class="inline">nil</code> is returned and revenue metrics are dropped.</p></div> </div> <div class="summary-row"> <div class="summary-signature"> <a href="#remove_internal_visits_metric/1" translate="no">remove_internal_visits_metric(result)</a> </div> </div> <div class="summary-row"> <div class="summary-signature"> <a href="#remove_internal_visits_metric/2" translate="no">remove_internal_visits_metric(results, metrics)</a> </div> <div class="summary-synopsis"><p><code class="inline">__internal_visits</code> is fetched when querying bounce rate and visit duration, as it is needed to calculate these from imported data. This function removes that metric from all entries in the results list.</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="cast_revenue_metrics_to_money/2"> <div class="detail-header"> <a href="#cast_revenue_metrics_to_money/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">cast_revenue_metrics_to_money(results, revenue_goals)</h1> <a href="https://github.com/plausible/analytics/blob/main/lib/plausible/stats/util.ex#L64" 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="get_revenue_tracking_currency/3"> <div class="detail-header"> <a href="#get_revenue_tracking_currency/3" 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">get_revenue_tracking_currency(site, query, metrics)</h1> <a href="https://github.com/plausible/analytics/blob/main/lib/plausible/stats/util.ex#L39" 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> get_revenue_tracking_currency(<a href="Plausible.Site.html#t:t/0">Plausible.Site.t</a>(), <a href="Plausible.Stats.Query.html#t:t/0">Plausible.Stats.Query.t</a>(), [ <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">atom</a>() ]) :: {<a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">atom</a>() | nil, [<a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">atom</a>()]}</pre> </div> <p>Returns the common currency for the goal filters in a query. If there are no goal filters, or multiple currencies, <code class="inline">nil</code> is returned and revenue metrics are dropped.</p><p>Aggregating revenue data works only for same currency goals. If the query is filtered by goals with different currencies, for example, one USD and other EUR, revenue metrics are dropped.</p> </section> </section> <section class="detail" id="remove_internal_visits_metric/1"> <div class="detail-header"> <a href="#remove_internal_visits_metric/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">remove_internal_visits_metric(result)</h1> <a href="https://github.com/plausible/analytics/blob/main/lib/plausible/stats/util.ex#L22" 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="remove_internal_visits_metric/2"> <div class="detail-header"> <a href="#remove_internal_visits_metric/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">remove_internal_visits_metric(results, metrics)</h1> <a href="https://github.com/plausible/analytics/blob/main/lib/plausible/stats/util.ex#L13" 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><code class="inline">__internal_visits</code> is fetched when querying bounce rate and visit duration, as it is needed to calculate these from imported data. This function removes that metric from all entries in the results list.</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>