analytics/Plausible.Imported.html
2024-04-09 12:36:56 +00:00

759 lines
25 KiB
HTML

<!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.Imported — 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-9A4530EB.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/imported.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.Imported</span>
<small class="app-vsn" translate="no">(Plausible v0.0.1)</small>
</h1>
<section id="moduledoc">
<p>Context for managing site statistics imports.</p><p>Currently following importers are implemented:</p><ul><li><a href="Plausible.Imported.UniversalAnalytics.html"><code class="inline">Plausible.Imported.UniversalAnalytics</code></a> - existing mechanism, for legacy Google
analytics formerly known as &quot;Google Analytics&quot;</li><li><a href="Plausible.Imported.NoopImporter.html"><code class="inline">Plausible.Imported.NoopImporter</code></a> - importer stub, used mainly for testing purposes</li><li><a href="Plausible.Imported.CSVImporter.html"><code class="inline">Plausible.Imported.CSVImporter</code></a> - CSV importer from S3</li></ul><p>For more information on implementing importers, see <a href="Plausible.Imported.Importer.html"><code class="inline">Plausible.Imported.Importer</code></a>.</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="#clamp_dates/3" translate="no">clamp_dates(site, start_date, end_date)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#clamp_dates/4" translate="no">clamp_dates(occupied_ranges, cutoff_date, start_date, end_date)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#delete_imports_for_site/1" translate="no">delete_imports_for_site(site)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#get_cutoff_date/1" translate="no">get_cutoff_date(site)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#get_import/2" translate="no">get_import(site, import_id)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#get_imports_date_range/1" translate="no">get_imports_date_range(site)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#get_occupied_date_ranges/1" translate="no">get_occupied_date_ranges(site)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#list_all_imports/2" translate="no">list_all_imports(site, status \\ nil)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#list_complete_import_ids/1" translate="no">list_complete_import_ids(site)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#listen/0" translate="no">listen()</a>
</div>
<div class="summary-synopsis"><p>See <a href="Plausible.Imported.Importer.html#listen/0"><code class="inline">Plausible.Imported.Importer.listen/0</code></a>.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#load_import_data/1" translate="no">load_import_data(site)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#max_complete_imports/0" translate="no">max_complete_imports()</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#other_imports_in_progress?/1" translate="no">other_imports_in_progress?(site_import)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#schemas/0" translate="no">schemas()</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#tables/0" translate="no">tables()</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>
</a>
<span class="text">Functions</span>
</h1>
<div class="functions-list">
<section class="detail" id="clamp_dates/3">
<div class="detail-header">
<a href="#clamp_dates/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">clamp_dates(site, start_date, end_date)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/imported.ex#L163" 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> clamp_dates(<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>(), <a href="https://hexdocs.pm/elixir/Date.html#t:t/0">Date.t</a>()) ::
{:ok, <a href="https://hexdocs.pm/elixir/Date.html#t:t/0">Date.t</a>(), <a href="https://hexdocs.pm/elixir/Date.html#t:t/0">Date.t</a>()} | {:error, :no_time_window}</pre>
</div>
</section>
</section>
<section class="detail" id="clamp_dates/4">
<div class="detail-header">
<a href="#clamp_dates/4" 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">clamp_dates(occupied_ranges, cutoff_date, start_date, end_date)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/imported.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">
<div class="specs">
<pre translate="no"><span class="attribute">@spec</span> clamp_dates([<a href="https://hexdocs.pm/elixir/Date.Range.html#t:t/0">Date.Range.t</a>()], <a href="https://hexdocs.pm/elixir/Date.html#t:t/0">Date.t</a>(), <a href="https://hexdocs.pm/elixir/Date.html#t:t/0">Date.t</a>(), <a href="https://hexdocs.pm/elixir/Date.html#t:t/0">Date.t</a>()) ::
{:ok, <a href="https://hexdocs.pm/elixir/Date.html#t:t/0">Date.t</a>(), <a href="https://hexdocs.pm/elixir/Date.html#t:t/0">Date.t</a>()} | {:error, :no_time_window}</pre>
</div>
</section>
</section>
<section class="detail" id="delete_imports_for_site/1">
<div class="detail-header">
<a href="#delete_imports_for_site/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">delete_imports_for_site(site)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/imported.ex#L155" 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> delete_imports_for_site(<a href="Plausible.Site.html#t:t/0">Plausible.Site.t</a>()) :: :ok</pre>
</div>
</section>
</section>
<section class="detail" id="get_cutoff_date/1">
<div class="detail-header">
<a href="#get_cutoff_date/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">get_cutoff_date(site)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/imported.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> get_cutoff_date(<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>()</pre>
</div>
</section>
</section>
<section class="detail" id="get_import/2">
<div class="detail-header">
<a href="#get_import/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_import(site, import_id)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/imported.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">
<div class="specs">
<pre translate="no"><span class="attribute">@spec</span> get_import(<a href="Plausible.Site.html#t:t/0">Plausible.Site.t</a>(), <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">non_neg_integer</a>()) ::
<a href="Plausible.Imported.SiteImport.html#t:t/0">Plausible.Imported.SiteImport.t</a>() | nil</pre>
</div>
</section>
</section>
<section class="detail" id="get_imports_date_range/1">
<div class="detail-header">
<a href="#get_imports_date_range/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">get_imports_date_range(site)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/imported.ex#L127" 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_imports_date_range(<a href="Plausible.Site.html#t:t/0">Plausible.Site.t</a>()) :: %{
start_date: <a href="https://hexdocs.pm/elixir/Date.html#t:t/0">Date.t</a>() | nil,
end_date: <a href="https://hexdocs.pm/elixir/Date.html#t:t/0">Date.t</a>() | nil
}</pre>
</div>
</section>
</section>
<section class="detail" id="get_occupied_date_ranges/1">
<div class="detail-header">
<a href="#get_occupied_date_ranges/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">get_occupied_date_ranges(site)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/imported.ex#L185" 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_occupied_date_ranges(<a href="Plausible.Site.html#t:t/0">Plausible.Site.t</a>()) :: [<a href="https://hexdocs.pm/elixir/Date.Range.html#t:t/0">Date.Range.t</a>()]</pre>
</div>
</section>
</section>
<section class="detail" id="list_all_imports/2">
<span id="list_all_imports/1"></span>
<div class="detail-header">
<a href="#list_all_imports/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">list_all_imports(site, status \\ nil)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/imported.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">
<div class="specs">
<pre translate="no"><span class="attribute">@spec</span> list_all_imports(<a href="Plausible.Site.html#t:t/0">Plausible.Site.t</a>(), <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">atom</a>()) :: [
<a href="Plausible.Imported.SiteImport.html#t:t/0">Plausible.Imported.SiteImport.t</a>()
]</pre>
</div>
</section>
</section>
<section class="detail" id="list_complete_import_ids/1">
<div class="detail-header">
<a href="#list_complete_import_ids/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_complete_import_ids(site)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/imported.ex#L103" 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> list_complete_import_ids(<a href="Plausible.Site.html#t:t/0">Plausible.Site.t</a>()) :: [<a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">non_neg_integer</a>()]</pre>
</div>
</section>
</section>
<section class="detail" id="listen/0">
<div class="detail-header">
<a href="#listen/0" 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">listen()</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/imported.ex#L70" 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>See <a href="Plausible.Imported.Importer.html#listen/0"><code class="inline">Plausible.Imported.Importer.listen/0</code></a>.</p>
</section>
</section>
<section class="detail" id="load_import_data/1">
<div class="detail-header">
<a href="#load_import_data/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">load_import_data(site)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/imported.ex#L50" 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> load_import_data(<a href="Plausible.Site.html#t:t/0">Plausible.Site.t</a>()) :: <a href="Plausible.Site.html#t:t/0">Plausible.Site.t</a>()</pre>
</div>
</section>
</section>
<section class="detail" id="max_complete_imports/0">
<div class="detail-header">
<a href="#max_complete_imports/0" 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">max_complete_imports()</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/imported.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> max_complete_imports() :: <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">non_neg_integer</a>()</pre>
</div>
</section>
</section>
<section class="detail" id="other_imports_in_progress?/1">
<div class="detail-header">
<a href="#other_imports_in_progress?/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">other_imports_in_progress?(site_import)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/imported.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">
<div class="specs">
<pre translate="no"><span class="attribute">@spec</span> other_imports_in_progress?(<a href="Plausible.Imported.SiteImport.html#t:t/0">Plausible.Imported.SiteImport.t</a>()) :: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">boolean</a>()</pre>
</div>
</section>
</section>
<section class="detail" id="schemas/0">
<div class="detail-header">
<a href="#schemas/0" 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">schemas()</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/imported.ex#L41" 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> schemas() :: [<a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">module</a>()]</pre>
</div>
</section>
</section>
<section class="detail" id="tables/0">
<div class="detail-header">
<a href="#tables/0" 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">tables()</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/imported.ex#L44" 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> tables() :: [<a href="https://hexdocs.pm/elixir/String.html#t:t/0">String.t</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>