2024-01-29 13:17:25 +03:00
|
|
|
<!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>Plausible.Stats.Filters.Utils — 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>
|
2024-03-01 11:54:34 +03:00
|
|
|
<script src="dist/sidebar_items-CB02188E.js"></script>
|
2024-01-29 13:17:25 +03:00
|
|
|
|
|
|
|
|
<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/stats/filters/utils.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.Filters.Utils</span>
|
|
|
|
|
<small class="app-vsn" translate="no">(Plausible v0.0.1)</small>
|
|
|
|
|
|
|
|
|
|
</h1>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section id="moduledoc">
|
|
|
|
|
<p>Contains utility functions shared between <code class="inline">DashboardFilterParser</code>
|
|
|
|
|
and <code class="inline">StatsAPIFilterParser</code>.</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>
|
|
|
|
|
</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="#list_expression?/1" translate="no">list_expression?(expression)</a>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="summary-row">
|
|
|
|
|
<div class="summary-signature">
|
|
|
|
|
<a href="#parse_member_list/1" translate="no">parse_member_list(raw_value)</a>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="summary-row">
|
|
|
|
|
<div class="summary-signature">
|
|
|
|
|
<a href="#remove_escape_chars/1" translate="no">remove_escape_chars(value)</a>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="summary-row">
|
|
|
|
|
<div class="summary-signature">
|
|
|
|
|
<a href="#unwrap_goal_value/1" translate="no">unwrap_goal_value(goals)</a>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="summary-synopsis"><p>Does the opposite to <code class="inline">wrap_goal_value</code>, turning the <code class="inline">{:page, path}</code>
|
|
|
|
|
and <code class="inline">{:event, name}</code> tuples into strings. Similarly, when given a
|
|
|
|
|
list, maps all the list elements into strings with the same logic.</p></div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="summary-row">
|
|
|
|
|
<div class="summary-signature">
|
|
|
|
|
<a href="#wildcard_expression?/1" translate="no">wildcard_expression?(expression)</a>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="summary-row">
|
|
|
|
|
<div class="summary-signature">
|
|
|
|
|
<a href="#wrap_goal_value/1" translate="no">wrap_goal_value(goals)</a>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="summary-synopsis"><p>Wraps the given goal filter into a tuple where the first element
|
|
|
|
|
represents the goal type (i.e. <code class="inline">page</code> or <code class="inline">event</code>), and the second
|
|
|
|
|
element is either the page path or the event name.</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>
|
|
|
|
|
</a>
|
|
|
|
|
<span class="text">Functions</span>
|
|
|
|
|
</h1>
|
|
|
|
|
<div class="functions-list">
|
|
|
|
|
<section class="detail" id="list_expression?/1">
|
|
|
|
|
|
|
|
|
|
<div class="detail-header">
|
|
|
|
|
<a href="#list_expression?/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">list_expression?(expression)</h1>
|
|
|
|
|
|
|
|
|
|
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/stats/filters/utils.ex#L9" 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="parse_member_list/1">
|
|
|
|
|
|
|
|
|
|
<div class="detail-header">
|
|
|
|
|
<a href="#parse_member_list/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">parse_member_list(raw_value)</h1>
|
|
|
|
|
|
|
|
|
|
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/stats/filters/utils.ex#L17" 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_escape_chars/1">
|
|
|
|
|
|
|
|
|
|
<div class="detail-header">
|
|
|
|
|
<a href="#remove_escape_chars/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_escape_chars(value)</h1>
|
|
|
|
|
|
|
|
|
|
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/stats/filters/utils.ex#L23" 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="unwrap_goal_value/1">
|
|
|
|
|
|
|
|
|
|
<div class="detail-header">
|
|
|
|
|
<a href="#unwrap_goal_value/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">unwrap_goal_value(goals)</h1>
|
|
|
|
|
|
|
|
|
|
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/stats/filters/utils.ex#L66" 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>Does the opposite to <code class="inline">wrap_goal_value</code>, turning the <code class="inline">{:page, path}</code>
|
|
|
|
|
and <code class="inline">{:event, name}</code> tuples into strings. Similarly, when given a
|
|
|
|
|
list, maps all the list elements into strings with the same logic.</p><h2 id="unwrap_goal_value/1-examples" class="section-heading">
|
|
|
|
|
<a href="#unwrap_goal_value/1-examples" class="hover-link">
|
|
|
|
|
<i class="ri-link-m" aria-hidden="true"></i>
|
|
|
|
|
</a>
|
|
|
|
|
<span class="text">Examples</span>
|
|
|
|
|
</h2>
|
|
|
|
|
<p> iex> Plausible.Stats.Filters.Utils.unwrap_goal_value({:page, "/register"})
|
|
|
|
|
"Visit /register"</p><p> iex> Plausible.Stats.Filters.Utils.unwrap_goal_value({:event, "Signup"})
|
|
|
|
|
"Signup"</p><p> iex> Plausible.Stats.Filters.Utils.unwrap_goal_value([{:event, "Signup"}, {:page, "/register"}])
|
|
|
|
|
["Signup", "Visit /register"]</p>
|
|
|
|
|
</section>
|
|
|
|
|
</section>
|
|
|
|
|
<section class="detail" id="wildcard_expression?/1">
|
|
|
|
|
|
|
|
|
|
<div class="detail-header">
|
|
|
|
|
<a href="#wildcard_expression?/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">wildcard_expression?(expression)</h1>
|
|
|
|
|
|
|
|
|
|
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/stats/filters/utils.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">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</section>
|
|
|
|
|
</section>
|
|
|
|
|
<section class="detail" id="wrap_goal_value/1">
|
|
|
|
|
|
|
|
|
|
<div class="detail-header">
|
|
|
|
|
<a href="#wrap_goal_value/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">wrap_goal_value(goals)</h1>
|
|
|
|
|
|
|
|
|
|
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/stats/filters/utils.ex#L46" 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>Wraps the given goal filter into a tuple where the first element
|
|
|
|
|
represents the goal type (i.e. <code class="inline">page</code> or <code class="inline">event</code>), and the second
|
|
|
|
|
element is either the page path or the event name.</p><p>Given a list of goal filter values, wraps all values based on the
|
|
|
|
|
same logic.</p><h2 id="wrap_goal_value/1-examples" class="section-heading">
|
|
|
|
|
<a href="#wrap_goal_value/1-examples" class="hover-link">
|
|
|
|
|
<i class="ri-link-m" aria-hidden="true"></i>
|
|
|
|
|
</a>
|
|
|
|
|
<span class="text">Examples</span>
|
|
|
|
|
</h2>
|
|
|
|
|
<p> iex> Plausible.Stats.Filters.Utils.wrap_goal_value("Visit /register")</p><p> iex> Plausible.Stats.Filters.Utils.wrap_goal_value("Signup")</p><p> iex> Plausible.Stats.Filters.Utils.wrap_goal_value(["Signup", "Visit /register"])
|
|
|
|
|
[{:event, "Signup"}, {:page, "/register"}]</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.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>
|
