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

Description Usage Arguments Details Value

View source: R/commons-downloads.R

Description

fetch_cbp_downloads_intranet downloads data on document download metrics for all Commons Library briefing papers on the intranet during the given dates and returns the data as a tibble. These are the landing pages for briefings whose ids begin with "SN" or "CBP".

Usage

1
2
3
4
5
6
7
8
9
fetch_cbp_downloads_intranet(
  start_date,
  end_date,
  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.

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.

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

Note that this is not all Commons briefing paper downloads, as it does not include downloads on briefing paper pages on the main Parliament website. Use fetch_cbp_downloads_public to retrieve equivalent data for the main Parliament website.

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.

Value

A tibble of document download metrics.


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