plausible/analytics
1
1
Fork 0
mirror of https://github.com/plausible/analytics.git synced 2024-11-23 11:12:15 +03:00
Code Issues Packages Projects Releases Wiki Activity
a6b4c8de76
analytics/Plausible.Stats.Query.html
ukutaht a6b4c8de76 deploy: 49bb57f601
2024-07-23 09:06:18 +00:00

705 lines
24 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.31.1">
<meta name="project" content="Plausible v0.0.1">
<title>Plausible.Stats.Query — 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-58316C0C.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/stats/query.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.Query</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>
</a>
<span class="text">Summary</span>
</h1>
<div class="summary-types summary">
<h2>
<a href="#types">Types</a>
</h2>
<div class="summary-row">
<div class="summary-signature">
<a href="#t:t/0" translate="no">t()</a>
</div>
</div>
</div>
<div class="summary-functions summary">
<h2>
<a href="#functions">Functions</a>
</h2>
<div class="summary-row">
<div class="summary-signature">
<a href="#add_filter/2" translate="no">add_filter(query, filter)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#build/2" translate="no">build(site, params)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#ensure_include_imported/2" translate="no">ensure_include_imported(query, requested?)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#from/2" translate="no">from(site, params)</a>
</div>
<div class="summary-synopsis"><p>Builds query from old-style params. New code should prefer Query.build</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#get_filter/2" translate="no">get_filter(query, name)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#get_filter_by_prefix/2" translate="no">get_filter_by_prefix(query, prefix)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#has_event_filters?/1" translate="no">has_event_filters?(query)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#put_experimental_reduced_joins/3" translate="no">put_experimental_reduced_joins(query, site, params)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#put_imported_opts/3" translate="no">put_imported_opts(query, site, params)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#remove_filters/2" translate="no">remove_filters(query, prefixes)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#set/2" translate="no">set(query, keywords)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#trace/2" translate="no">trace(query, metrics)</a>
</div>
</div>
</div>
</section>
<section id="types" class="details-list">
<h1 class="section-heading">
<a class="hover-link" href="#types">
<i class="ri-link-m" aria-hidden="true"></i>
</a>
<span class="text">Types</span>
</h1>
<div class="types-list">
<section class="detail" id="t:t/0">
<div class="detail-header">
<a href="#t:t/0" class="detail-link" title="Link to this type">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this type</span>
</a>
<h1 class="signature" translate="no">t()</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/stats/query.ex#L29" 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">@type</span> t() :: %Plausible.Stats.Query{
date_range: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
dimensions: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
experimental_reduced_joins?: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
filters: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
include: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
include_imported: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
interval: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
latest_import_end_date: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
legacy_breakdown: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
metrics: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
now: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
order_by: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
period: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
preloaded_goals: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
sample_threshold: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
skip_imported_reason: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
timezone: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
v2: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>()
}</pre>
</div>
</section>
</section>
</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="add_filter/2">
<div class="detail-header">
<a href="#add_filter/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">add_filter(query, filter)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/stats/query.ex#L73" 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="build/2">
<div class="detail-header">
<a href="#build/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">build(site, params)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/stats/query.ex#L31" 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="ensure_include_imported/2">
<div class="detail-header">
<a href="#ensure_include_imported/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">ensure_include_imported(query, requested?)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/stats/query.ex#L142" 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> ensure_include_imported(<a href="#t:t/0">t</a>(), <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">boolean</a>()) ::
:ok
| {:error,
:no_imported_data | :out_of_range | :unsupported_query | :not_requested}</pre>
</div>
</section>
</section>
<section class="detail" id="from/2">
<div class="detail-header">
<a href="#from/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">from(site, params)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/stats/query.ex#L47" 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> from(<a href="Plausible.Site.html#t:t/0">Plausible.Site.t</a>(), <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">map</a>()) :: <a href="#t:t/0">t</a>()</pre>
</div>
<p>Builds query from old-style params. New code should prefer Query.build</p>
</section>
</section>
<section class="detail" id="get_filter/2">
<div class="detail-header">
<a href="#get_filter/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">get_filter(query, name)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/stats/query.ex#L106" 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_filter_by_prefix/2">
<div class="detail-header">
<a href="#get_filter_by_prefix/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">get_filter_by_prefix(query, prefix)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/stats/query.ex#L100" 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="has_event_filters?/1">
<div class="detail-header">
<a href="#has_event_filters?/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_event_filters?(query)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/stats/query.ex#L94" 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="put_experimental_reduced_joins/3">
<div class="detail-header">
<a href="#put_experimental_reduced_joins/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">put_experimental_reduced_joins(query, site, params)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/stats/query.ex#L51" 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="put_imported_opts/3">
<div class="detail-header">
<a href="#put_imported_opts/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">put_imported_opts(query, site, params)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/stats/query.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">
</section>
</section>
<section class="detail" id="remove_filters/2">
<div class="detail-header">
<a href="#remove_filters/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_filters(query, prefixes)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/stats/query.ex#L79" 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="set/2">
<div class="detail-header">
<a href="#set/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">set(query, keywords)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/stats/query.ex#L63" 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="trace/2">
<div class="detail-header">
<a href="#trace/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">trace(query, metrics)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/stats/query.ex#L154" 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> trace(
%Plausible.Stats.Query{
date_range: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
dimensions: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
experimental_reduced_joins?: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
filters: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
include: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
include_imported: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
interval: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
latest_import_end_date: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
legacy_breakdown: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
metrics: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
now: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
order_by: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
period: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
preloaded_goals: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
sample_threshold: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
skip_imported_reason: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
timezone: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
v2: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>()
},
[<a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">atom</a>()]
) :: %Plausible.Stats.Query{
date_range: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
dimensions: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
experimental_reduced_joins?: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
filters: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
include: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
include_imported: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
interval: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
latest_import_end_date: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
legacy_breakdown: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
metrics: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
now: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
order_by: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
period: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
preloaded_goals: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
sample_threshold: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
skip_imported_reason: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
timezone: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
v2: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>()
}</pre>
</div>
</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>
Reference in New Issue View Git Blame Copy Permalink