lh_raw_1: Download Pagespeed v4 raport for an URL as a nested list

In Leszek-Sieminski/pagespeedParseR: R Interface for Google Pagespeed Insights API

Description

This function can check a single URL (character) and parse the output into a data frame. This data frame contain all the possible information from Pagespeed ver 5.

Usage

lh_raw_1(url, key = Sys.getenv("PAGESPEED_API_KEY"), strategy = NULL,
  categories = "performance", interval = 0.5, locale = NULL,
  utm_campaign = NULL, utm_source = NULL)

Arguments

url	string. The URL to fetch and analyze
key	string. Pagespeed API key to authenticate. Defaults to "PAGESPEED_API_KEY" enviroment variable.
strategy	string. The analysis strategy to use. Options: "desktop" or "mobile". Defaults to "desktop"
categories	string. A Lighthouse category to run. Defaults to "performance". See more in Details section
interval	numeric. Number of seconds to wait between multiple queries. Defaults to 0.5 second.
locale	string. The locale used to localize formatted results
utm_campaign	string. Campaign name for analytics. Defaults to NULL
utm_source	string. Campaign source for analytics. Defaults to NULL

Details

This function uses version 5 of the API. Check function ps_raw_1() for version 4. If you need less information but in form of a data frame, use lh_simple_1().

The category parameter regulates which of the tests' categories from Lighthouse are to be run. You can select more than one. Options: "accessibility", "best-practices", "performance", "pwa", "seo".

Value

nested list

Examples

## Not run: 
single_url_raw_output_5 <- lh_raw_1("https://www.google.com/")

## End(Not run)

Leszek-Sieminski/pagespeedParseR documentation built on May 12, 2021, 2:29 p.m.