在R中使用GTmetrix REST v2.0

Question

我正在尝试集成使用GTmetrix的某些网站的性能测试。使用API，我可以使用Microsoft中的SEO连接器工具运行测试并提取结果。然而，它使用的xml与较早版本的API，一些新的测试是不可用的。最新版本是2.0

xml的链接在这里：GTmetrix XMLforAPI0.1。

我试过使用httr和jsonlite库。但是，我不知道如何使用API进行身份验证，运行测试并提取结果。

API的文档可在API文档上获得。

library(httr)
library(jsonlite)

url  <- "https://www.berkeley.edu" # URL to be tested
location <- 1 # testing Location
browser <- 3 # Browser to be used for testing
res  <- GET("https://gtmetrix.com/api/gtmetrix-openapi-v2.0.json")
data <- fromJSON(rawToChar(res$content))

Answer 1

更新2021-11-08：

我创建了一个小型库，通过R与GTmetrix对话。这里有一些基本的健全检查，但很明显，这仍在进行中，而且还存在一些(潜在的关键)错误。不过，你可以随便看看。会喜欢一些反馈的。

# Install and load library.
devtools::install_github("RomanAbashin/rgtmx")
library(rgtmx)

更新2021-11-12:它现在可以在CRAN上使用。:-)

# Install and load library.
install_packages("rgtmx")
library(rgtmx)

开始测试(并获得结果)

# Minimal example #1.
# Returns the final report after checking test status roughly every 3 seconds. 
result <- start_test("google.com", "[API_KEY]")

这将启动一个测试，并等待生成报告，并以data.frame的形式返回结果。或者，您只需通过参数wait_for_completion = FALSE返回测试ID和其他元数据即可。

# Minimal example #2.
# Returns just the test ID and some meta data.
result <- start_test("google.com", "[API_KEY]", wait_for_completion = FALSE)

其他可选参数：location、browser、report、retention、httpauth_username、httpauth_password、adblock、cookies、video、stop_onload、throttle、allow_url、block_url、dns、simulate_device、user_agent、browser_width、browser_height、d23、browser_rotate。

显示可用浏览器

show_available_browsers("[API_KEY]")

显示可用位置

show_available_locations("[API_KEY]")

获得特定测试

get_test("[TEST_ID]", "[API_KEY]")

得到具体的报告

get_report("[REPORT_ID]", "[API_KEY]")

做所有的测试

get_all_tests("[API_KEY]")

获取帐户状态

get_account_status("[API_KEY]")

原来的答案：

实际上，很简单：

0。设定测试参数。

# Your api key from the GTmetrix console.
api_key <- "[Key]"

# All attributes except URL are optional, and the availability
# of certain options may depend on the tier of your account.

# URL to test.
url <- "https://www.worldwildlife.org/"
# Testing location ID.
location_id <- 1
# Browser ID.
browser_id <- 3

1.开始测试

res_test_start  <- httr::POST(
    url = "https://gtmetrix.com/api/2.0/tests",
    httr::authenticate(api_key, ""),
    httr::content_type("application/vnd.api+json"),
    body = jsonlite::toJSON(
        list(
            "data" = list(
                "type" = "test",
                "attributes" = list(
                    "url" = url,
                    # Optional attributes go here.
                    "location" = location_id,
                    "browser" = browser_id
                )
            )
        ),
        auto_unbox = TRUE
    ),
    encode = "raw"
)

2.获取测试ID

test_id <- jsonlite::fromJSON(rawToChar(res_test_start$content))$data$id

3.获取报告ID

# Wait a bit, as generating the report can take some time.
res_test_status <- httr::GET(
    url = paste0("https://gtmetrix.com/api/2.0/tests/", test_id),
    httr::authenticate(api_key, ""),
    httr::content_type("application/vnd.api+json")
)

# If this returns the test ID, the report is not ready, yet.
report_id <- jsonlite::fromJSON(rawToChar(res_test_status$content))$data$id

4.取得报告

res_report <- httr::GET(
    url = paste0("https://gtmetrix.com/api/2.0/reports/", report_id),
    httr::authenticate(api_key, ""),
    httr::content_type("application/vnd.api+json")
)

# The report is a nested list with the results as you know them from GTmetrix.
report <- jsonlite::fromJSON(rawToChar(res_report$content))$data

我有点想为此做点什么，因为似乎没有R库.