2023-07-12 11:28:07 +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" >
2024-01-16 10:41:49 +03:00
< meta name = "generator" content = "ExDoc v0.31.1" >
2023-07-12 11:28:07 +03:00
< meta name = "project" content = "Plausible v0.0.1" >
2024-01-11 10:50:44 +03:00
2024-03-12 20:09:07 +03:00
< title > Plausible.Google.UA.API — Plausible v0.0.1< / title >
2024-01-16 10:41:49 +03:00
< link rel = "stylesheet" href = "dist/html-elixir-FM2CSD74.css" / >
2023-07-12 11:28:07 +03:00
< script src = "dist/handlebars.runtime-NWIB6V2M.js" > < / script >
2024-01-11 10:50:44 +03:00
< script src = "dist/handlebars.templates-43PMFBC7.js" > < / script >
2024-03-26 14:55:55 +03:00
< script src = "dist/sidebar_items-4F1F3320.js" > < / script >
2023-07-12 11:28:07 +03:00
< script src = "docs_config.js" > < / script >
2024-01-16 10:41:49 +03:00
< script async src = "dist/html-L4O5OK2K.js" > < / script >
2023-07-12 11:28:07 +03:00
< / 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" >
2024-01-16 10:41:49 +03:00
< button id = "sidebar-menu" class = "sidebar-button sidebar-toggle" aria-label = "toggle sidebar" aria-controls = "sidebar" >
2023-07-12 11:28:07 +03:00
< i class = "ri-menu-line ri-lg" title = "Collapse/expand sidebar" > < / i >
< / button >
2024-01-16 10:41:49 +03:00
< div class = "background-layer" > < / div >
2024-01-11 10:50:44 +03:00
< nav id = "sidebar" class = "sidebar" >
2023-07-12 11:28:07 +03:00
< div class = "sidebar-header" >
2024-01-11 10:50:44 +03:00
< div class = "sidebar-projectInfo" >
2023-07-12 11:28:07 +03:00
2024-01-11 10:50:44 +03:00
< a href = "readme.html" class = "sidebar-projectImage" >
< img src = "assets/logo.png" alt = "Plausible" / >
< / a >
2023-07-12 11:28:07 +03:00
2024-01-11 10:50:44 +03:00
< div >
< a href = "readme.html" class = "sidebar-projectName" translate = "no" >
2023-07-12 11:28:07 +03:00
Plausible
2024-01-11 10:50:44 +03:00
< / a >
< div class = "sidebar-projectVersion" translate = "no" >
v0.0.1
< / div >
2023-07-12 11:28:07 +03:00
< / div >
< / div >
2024-01-11 10:50:44 +03:00
< 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 >
2023-07-12 11:28:07 +03:00
2024-01-11 10:50:44 +03:00
< / ul >
< / div >
2023-07-12 11:28:07 +03:00
2024-01-11 10:50:44 +03:00
< 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 >
2023-07-12 11:28:07 +03:00
2024-01-11 10:50:44 +03:00
< 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 >
2023-07-12 11:28:07 +03:00
2024-01-11 10:50:44 +03:00
< 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 >
2023-07-12 11:28:07 +03:00
2024-01-11 10:50:44 +03:00
< main class = "content" >
2023-07-12 11:28:07 +03:00
< output role = "status" id = "toast" > < / output >
< div class = "content-outer" >
< div id = "content" class = "content-inner" >
2024-01-11 10:50:44 +03:00
< 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 >
2024-01-16 10:41:49 +03:00
< div class = "autocomplete" >
< / div >
2024-01-11 10:50:44 +03:00
< button class = "icon-settings display-settings" >
< i class = "ri-settings-3-line" > < / i >
< span class = "sr-only" > Settings< / span >
< / button >
< / div >
2024-01-16 10:41:49 +03:00
2024-01-11 10:50:44 +03:00
< / div >
2023-07-12 11:28:07 +03:00
< h1 >
2024-03-12 20:09:07 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible/google/ua/api.ex#L1" title = "View Source" class = "icon-action" rel = "help" >
2023-07-12 11:28:07 +03:00
< i class = "ri-code-s-slash-line" aria-hidden = "true" > < / i >
< span class = "sr-only" > View Source< / span >
< / a >
2024-03-12 20:09:07 +03:00
< span translate = "no" > Plausible.Google.UA.API< / span >
2023-07-12 11:28:07 +03:00
< small class = "app-vsn" translate = "no" > (Plausible v0.0.1)< / small >
< / h1 >
2024-03-12 20:09:07 +03:00
< section id = "moduledoc" >
< p > API for Universal Analytics< / p >
< / section >
2023-07-12 11:28:07 +03:00
< 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 >
2024-01-11 10:50:44 +03:00
< span class = "text" > Summary< / span >
2023-07-12 11:28:07 +03:00
< / h1 >
< div class = "summary-types summary" >
< h2 >
< a href = "#types" > Types< / a >
< / h2 >
< div class = "summary-row" >
< div class = "summary-signature" >
< a href = "#t:google_analytics_view/0" translate = "no" > google_analytics_view()< / a >
< / div >
< / div >
< div class = "summary-row" >
< div class = "summary-signature" >
< a href = "#t:import_auth/0" translate = "no" > import_auth()< / a >
< / div >
< / div >
< / div >
< div class = "summary-functions summary" >
< h2 >
< a href = "#functions" > Functions< / a >
< / h2 >
< div class = "summary-row" >
< div class = "summary-signature" >
2024-01-23 12:24:50 +03:00
< a href = "#fetch_and_persist/2" translate = "no" > fetch_and_persist(report_request, opts \\ [])< / a >
2023-07-12 11:28:07 +03:00
< / div >
< / div >
< div class = "summary-row" >
< div class = "summary-signature" >
2024-03-12 20:09:07 +03:00
< a href = "#get_analytics_start_date/2" translate = "no" > get_analytics_start_date(access_token, view_id)< / a >
2023-07-12 11:28:07 +03:00
< / div >
< / div >
< div class = "summary-row" >
< div class = "summary-signature" >
< a href = "#get_view/2" translate = "no" > get_view(access_token, lookup_id)< / a >
< / div >
< div class = "summary-synopsis" > < p > Returns a single Google Analytics view if the user has access to it.< / p > < / div >
< / div >
< div class = "summary-row" >
< div class = "summary-signature" >
2024-01-23 12:24:50 +03:00
< a href = "#import_analytics/4" translate = "no" > import_analytics(date_range, view_id, auth, persist_fn)< / a >
2023-07-12 11:28:07 +03:00
< / div >
< div class = "summary-synopsis" > < p > Imports stats from a Google Analytics UA view to a Plausible site.< / p > < / div >
< / div >
< div class = "summary-row" >
< div class = "summary-signature" >
< a href = "#list_views/1" translate = "no" > list_views(access_token)< / a >
< / div >
< div class = "summary-synopsis" > < p > Lists Google Analytics views grouped by hostname.< / p > < / 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 >
2023-07-25 10:58:48 +03:00
< / a >
2024-01-11 10:50:44 +03:00
< span class = "text" > Types< / span >
2023-07-12 11:28:07 +03:00
< / h1 >
< div class = "types-list" >
< section class = "detail" id = "t:google_analytics_view/0" >
< div class = "detail-header" >
< a href = "#t:google_analytics_view/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" > google_analytics_view()< / h1 >
2024-03-12 20:09:07 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible/google/ua/api.ex#L9" class = "icon-action" rel = "help" title = "View Source" >
2023-07-12 11:28:07 +03:00
< 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 > google_analytics_view() :: {view_name :: < a href = "https://hexdocs.pm/elixir/String.html#t:t/0" > String.t< / a > (), view_id :: < a href = "https://hexdocs.pm/elixir/String.html#t:t/0" > String.t< / a > ()}< / pre >
< / div >
< / section >
< / section >
< section class = "detail" id = "t:import_auth/0" >
< div class = "detail-header" >
< a href = "#t:import_auth/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" > import_auth()< / h1 >
2024-03-12 20:09:07 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible/google/ua/api.ex#L11" class = "icon-action" rel = "help" title = "View Source" >
2023-07-12 11:28:07 +03:00
< 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 > import_auth() ::
{access_token :: < a href = "https://hexdocs.pm/elixir/String.html#t:t/0" > String.t< / a > (), refresh_token :: < a href = "https://hexdocs.pm/elixir/String.html#t:t/0" > String.t< / a > (),
expires_at :: < a href = "https://hexdocs.pm/elixir/String.html#t:t/0" > String.t< / 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 >
2023-07-25 10:58:48 +03:00
< / a >
2024-01-11 10:50:44 +03:00
< span class = "text" > Functions< / span >
2023-07-12 11:28:07 +03:00
< / h1 >
< div class = "functions-list" >
2024-01-23 12:24:50 +03:00
< section class = "detail" id = "fetch_and_persist/2" >
2023-07-12 11:28:07 +03:00
2024-01-23 12:24:50 +03:00
< span id = "fetch_and_persist/1" > < / span >
2023-07-12 11:28:07 +03:00
< div class = "detail-header" >
2024-01-23 12:24:50 +03:00
< a href = "#fetch_and_persist/2" class = "detail-link" title = "Link to this function" >
2023-07-12 11:28:07 +03:00
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< span class = "sr-only" > Link to this function< / span >
< / a >
2024-01-23 12:24:50 +03:00
< h1 class = "signature" translate = "no" > fetch_and_persist(report_request, opts \\ [])< / h1 >
2023-07-12 11:28:07 +03:00
2024-03-21 13:38:02 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible/google/ua/api.ex#L113" class = "icon-action" rel = "help" title = "View Source" >
2023-07-12 11:28:07 +03:00
< 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" >
2024-03-12 20:09:07 +03:00
< pre translate = "no" > < span class = "attribute" > @spec< / span > fetch_and_persist(< a href = "Plausible.Google.UA.ReportRequest.html#t:t/0" > Plausible.Google.UA.ReportRequest.t< / a > (), < a href = "https://hexdocs.pm/elixir/Keyword.html#t:t/0" > Keyword.t< / a > ()) ::
2023-07-12 11:28:07 +03:00
:ok | {:error, < a href = "https://hexdocs.pm/elixir/typespecs.html#built-in-types" > term< / a > ()}< / pre >
< / div >
< / section >
< / section >
2024-03-12 20:09:07 +03:00
< section class = "detail" id = "get_analytics_start_date/2" >
2023-07-12 11:28:07 +03:00
< div class = "detail-header" >
2024-03-12 20:09:07 +03:00
< a href = "#get_analytics_start_date/2" class = "detail-link" title = "Link to this function" >
2023-07-12 11:28:07 +03:00
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< span class = "sr-only" > Link to this function< / span >
< / a >
2024-03-12 20:09:07 +03:00
< h1 class = "signature" translate = "no" > get_analytics_start_date(access_token, view_id)< / h1 >
2023-07-12 11:28:07 +03:00
2024-03-21 13:38:02 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible/google/ua/api.ex#L63" class = "icon-action" rel = "help" title = "View Source" >
2023-07-12 11:28:07 +03:00
< 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_view/2" >
< div class = "detail-header" >
< a href = "#get_view/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_view(access_token, lookup_id)< / h1 >
2024-03-21 13:38:02 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible/google/ua/api.ex#L46" class = "icon-action" rel = "help" title = "View Source" >
2023-07-12 11:28:07 +03:00
< 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_view(access_token :: < a href = "https://hexdocs.pm/elixir/String.html#t:t/0" > String.t< / a > (), lookup_id :: < a href = "https://hexdocs.pm/elixir/String.html#t:t/0" > String.t< / a > ()) ::
{:ok, < a href = "#t:google_analytics_view/0" > google_analytics_view< / a > ()} | {:ok, nil} | {:error, < a href = "https://hexdocs.pm/elixir/typespecs.html#built-in-types" > term< / a > ()}< / pre >
< / div >
< p > Returns a single Google Analytics view if the user has access to it.< / p >
< / section >
< / section >
< section class = "detail" id = "import_analytics/4" >
< div class = "detail-header" >
< a href = "#import_analytics/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 >
2024-01-23 12:24:50 +03:00
< h1 class = "signature" translate = "no" > import_analytics(date_range, view_id, auth, persist_fn)< / h1 >
2023-07-12 11:28:07 +03:00
2024-03-21 13:38:02 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible/google/ua/api.ex#L87" class = "icon-action" rel = "help" title = "View Source" >
2023-07-12 11:28:07 +03:00
< 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" >
2024-01-23 12:24:50 +03:00
< pre translate = "no" > < span class = "attribute" > @spec< / span > import_analytics(
< a href = "https://hexdocs.pm/elixir/Date.Range.html#t:t/0" > Date.Range.t< / a > (),
< a href = "https://hexdocs.pm/elixir/String.html#t:t/0" > String.t< / a > (),
< a href = "#t:import_auth/0" > import_auth< / a > (),
(< a href = "https://hexdocs.pm/elixir/String.html#t:t/0" > String.t< / a > (), [< a href = "https://hexdocs.pm/elixir/typespecs.html#basic-types" > map< / a > ()] -> :ok)
) ::
2023-07-12 11:28:07 +03:00
:ok | {:error, < a href = "https://hexdocs.pm/elixir/typespecs.html#built-in-types" > term< / a > ()}< / pre >
< / div >
< p > Imports stats from a Google Analytics UA view to a Plausible site.< / p > < p > This function fetches Google Analytics reports in batches of 7500 per
2024-01-23 12:24:50 +03:00
request. The batches are then passed to persist callback.< / p > < p > Requests to Google Analytics can fail, and are retried at most
2023-07-12 11:28:07 +03:00
5 times with an exponential backoff. Returns < code class = "inline" > :ok< / code > when
2024-01-23 12:24:50 +03:00
importing has finished or < code class = "inline" > {:error, term()}< / code > when a request to GA failed too
2023-07-12 11:28:07 +03:00
many times.< / p > < p > Useful links:< / p > < ul > < li > < a href = "https://plausible.io/docs/google-analytics-import" > Feature documentation< / a > < / li > < li > < a href = "https://developers.google.com/analytics/devguides/reporting/core/v4/rest/v4/reports/batchGet#ReportRequest" > GA API reference< / a > < / li > < li > < a href = "https://ga-dev-tools.web.app/dimensions-metrics-explorer" > GA Dimensions reference< / a > < / li > < / ul >
< / section >
< / section >
< section class = "detail" id = "list_views/1" >
< div class = "detail-header" >
< a href = "#list_views/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_views(access_token)< / h1 >
2024-03-12 20:09:07 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible/google/ua/api.ex#L26" class = "icon-action" rel = "help" title = "View Source" >
2023-07-12 11:28:07 +03:00
< 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_views(access_token :: < a href = "https://hexdocs.pm/elixir/String.html#t:t/0" > String.t< / a > ()) ::
{:ok, %{required(hostname :: < a href = "https://hexdocs.pm/elixir/String.html#t:t/0" > String.t< / a > ()) => [< a href = "#t:google_analytics_view/0" > google_analytics_view< / a > ()]}}
| {:error, < a href = "https://hexdocs.pm/elixir/typespecs.html#built-in-types" > term< / a > ()}< / pre >
< / div >
< p > Lists Google Analytics views grouped by hostname.< / 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
2024-01-16 10:41:49 +03:00
< 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
2023-07-12 11:28:07 +03:00
< a href = "https://elixir-lang.org" title = "Elixir" target = "_blank" translate = "no" > Elixir programming language< / a >
< / p >
< / footer >
< / div >
< / div >
2024-01-11 10:50:44 +03:00
< / main >
2023-07-12 11:28:07 +03:00
< / div >
< script src = "https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js" > < / script >
< script > mermaid . initialize ( { startOnLoad : true } ) < / script >
< / body >
< / html >
