fetch_cbp_downloads: Download data on document downloads for all Commons briefing...

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

Description

fetch_cbp_downloads downloads data on document download metrics for all Commons briefing papers on both the public Parliament website and the Parliamentary intranet during the given dates and returns the data as a tibble.

Usage

fetch_cbp_downloads(
  start_date,
  end_date,
  internal = FALSE,
  by_date = FALSE,
  by_page = FALSE,
  combine = 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.
internal	A boolean indicating whether to return only the results for downloads 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 page. The default is FALSE.
combine	A boolean indicating whether to combine the totals from different properties or to report them separately. 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. 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

By default, download figures are reported separately for each website property in Google Analytics that contains some of the requested data. You can use the combine argument to optionally combine download figures so that each result appears only once with figures totalled across all relevant properties.

Download figures can be requested by page. Google Analytics treats webpages requested with different query strings and section anchors as different pages in its downloads data. You can use the merge_paths argument to optionally sum the figures for pages with the same base path.

If combine and merge_paths are both set to TRUE, rows for different properties are combined before paths are merged.

Value

A tibble of document download metrics.

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