get_test {rgtmx} | R Documentation |
Get status and meta data of a specific test
Description
Get the status and meta data of a specific GTmetrix test. Returns the associated report instead, if the report is already completed.
Usage
get_test(test_id, api_key, wait_for_completion = TRUE)
Arguments
test_id |
ID of a GTmetrix test. (string) |
api_key |
An active GTmetrix API key. (string) |
wait_for_completion |
Whether the function should wait for the completion of the test. If TRUE (default), the report associated with the test ID will be requested in roughly 3 second intervals and returned, when successful. If FALSE, the meta data of the test will be returned. (TRUE, FALSE) |
Value
A data.frame object that contains either the test meta data or the GTmetrix report (if it's already completed)
Examples
## Not run: output_table <- get_test(
test_id = "TEST_ID",
api_key = "API_KEY"
)
## End(Not run)
[Package rgtmx version 0.1.4 Index]