View Source Plausible.Google.UA.API (Plausible v0.0.1)

API for Universal Analytics

Summary

Types

google_analytics_view()

import_auth()

Functions

fetch_and_persist(report_request, opts \\ [])

get_analytics_start_date(access_token, view_id)

get_view(access_token, lookup_id)

Returns a single Google Analytics view if the user has access to it.

import_analytics(date_range, view_id, auth, persist_fn)

Imports stats from a Google Analytics UA view to a Plausible site.

list_views(access_token)

Lists Google Analytics views grouped by hostname.

Types

google_analytics_view()

@type google_analytics_view() :: {view_name :: String.t(), view_id :: String.t()}

import_auth()

@type import_auth() ::
  {access_token :: String.t(), refresh_token :: String.t(),
   expires_at :: String.t()}

Functions

fetch_and_persist(report_request, opts \\ [])

@spec fetch_and_persist(Plausible.Google.UA.ReportRequest.t(), Keyword.t()) ::
  :ok | {:error, term()}

get_analytics_start_date(access_token, view_id)

get_view(access_token, lookup_id)

@spec get_view(access_token :: String.t(), lookup_id :: String.t()) ::
  {:ok, google_analytics_view()} | {:ok, nil} | {:error, term()}

Returns a single Google Analytics view if the user has access to it.

import_analytics(date_range, view_id, auth, persist_fn)

@spec import_analytics(
  Date.Range.t(),
  String.t(),
  import_auth(),
  (String.t(), [map()] -> :ok)
) ::
  :ok | {:error, term()}

Imports stats from a Google Analytics UA view to a Plausible site.

This function fetches Google Analytics reports in batches of 7500 per request. The batches are then passed to persist callback.

Requests to Google Analytics can fail, and are retried at most 5 times with an exponential backoff. Returns :ok when importing has finished or {:error, term()} when a request to GA failed too many times.

Useful links:

list_views(access_token)

@spec list_views(access_token :: String.t()) ::
  {:ok, %{required(hostname :: String.t()) => [google_analytics_view()]}}
  | {:error, term()}

Lists Google Analytics views grouped by hostname.