Description Usage Arguments Details Value
View source: R/microsite-events.R
fetch_ms_downloads_by_type
downloads data on document download
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.
1 2 3 4 5 6 7 8 9 10 11 |
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 briefing types. The default is a regexp that matches all pages. |
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. |
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 |
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
|
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. This makes it
easier to calculcate the total number of downloads from each distinct page.
A tibble of document download metrics.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.