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

Description Usage Arguments Details Value Examples

View source: R/ps_raw_1_s.R

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 4.

Usage

1
2
3
4
ps_raw_1(url, key = Sys.getenv("PAGESPEED_API_KEY"),
  strategy = "desktop", interval = 0.5, filter_third_party = NULL,
  locale = NULL, rule = NULL, screenshot = NULL, snapshots = 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"

interval

numeric. Number of seconds to wait between multiple queries. Defaults to 0.5 second.

filter_third_party

logical. Indicates if third party resources should be filtered out before PageSpeed analysis. Defaults to NULL (= FALSE)

locale

string. The locale used to localize formatted results

rule

string. A PageSpeed rule to run; if none are given, all rules are run

screenshot

logical. Indicates if binary data containing a screenshot should be included. Defaults to NULL (= FALSE)

snapshots

logical. Indicates if binary data containing snapshot images should be included. Defaults to NULL (= FALSE)

utm_campaign

string. Campaign name for analytics. Defaults to NULL

utm_source

string. Campaign source for analytics. Defaults to NULL

Details

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

Value

unformatted nested list

Examples

1
2
3
4
## Not run: 
single_url_raw_output <- ps_raw_1("https://www.google.com/")

## End(Not run)

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