fetch_ms_traffic_by_type: Download traffic data for different types of posts on the...

In olihawkins/clga: Download Traffic Data for Commons Library content from Google Analytics

Description

fetch_ms_traffic_by_type downloads data on traffic metrics for specific types of pages based on their path prefixes during the given dates and returns the data as a tibble. The specific types of pages to return are defined with a regular expression that identifies their prefixes within the page path.

Usage

fetch_ms_traffic_by_type(
  start_date,
  end_date,
  type_regexp = PATH_REGEXP_ALL,
  internal = FALSE,
  by_date = FALSE,
  by_page = FALSE,
  merge_paths = FALSE,
  anti_sample = FALSE,
  use_resource_quotas = FALSE
)

Arguments

start_date	The start date as an ISO 8601 string.
end_date	The end date as an ISO 8601 string.
type_regexp	A regular expression that describes the page path for one or more page types. The default is a regexp that matches all pages.
internal	A boolean indicating whether to return only the results for traffic from internal parliamentary networks. The default is FALSE.
by_date	A boolean indicating whether to return the results broken down by date. The default is FALSE.
by_page	A boolean indicating whether to return the results broken down by individual page. The default is FALSE.
merge_paths	A boolean indicating whether to aggregate figures for all pages that have the same root path i.e. for all pages whose paths differ only by their query strings or internal anchors. This parameter is ignored if by_page is set to FALSE. Note that while merging paths is necessary for analysis of individual pages it can introduce errors in the number of users by page, as the same user may visit the same page through URLs with different query strings and anchors. The default value is FALSE.
anti_sample	A boolean indicating whether to use googleAnalyticsR's anti-sample feature, which chunks API calls to keep the number of records requested under the API limits that trigger sampling. This makes the download process slower but ensures that all records are returned. Only use this feature if you see that an API request triggers sampling without it. The default is FALSE.
use_resource_quotas	A boolean indicating whether to use the resource quotas in Parliament's Google Analytics account to prevent sampling. This is a faster and more effective way to disable sampling than using anti_sample, but using resource quotas consumes tokens from a limited daily quota. Use this when anti_sample still fails to prevent sampling or is taking too long. Note that using resource quotas takes precendence over anti-samping: if use_resource_quotas is TRUE anti_sample is automatically set to FALSE. The default is FALSE.

Details

Traffic figures can be requested by page. Google Analytics treats webpages requested with different query strings and section anchors as different pages in its traffic data. You can use the merge_paths argument to optionally sum the figures for pages with the same base path. This makes it easier to calculcate the total number of views each distinct page has received, but note that this may introduce errors in the number of users, as a user may visit the same page using URLs with different query strings and anchors.

Value

A tibble of traffic metrics.

olihawkins/clga documentation built on Sept. 17, 2020, 7:19 a.m.