← Tools Reference

GTmetrix

GTmetrix integration (Developer Tools, Data). Imported from open-connector.

API key14 toolshttps://gtmetrix.com/api/2.0
GET
gtmetrix_get_account_status
Get the current GTmetrix account status, credits, and plan capabilities.

/status

GET
gtmetrix_list_locations
List GTmetrix test locations available to the connected account.

/locations

GET
gtmetrix_get_location
Get a single GTmetrix test location by ID.

/locations/{location_id}

1 parameter
ParamTypeRequiredDescription
location_idstringrequiredThe GTmetrix location ID.
GET
gtmetrix_list_browsers
List GTmetrix browsers that can be used for tests.

/browsers

GET
gtmetrix_get_browser
Get a single GTmetrix browser by ID.

/browsers/{browser_id}

1 parameter
ParamTypeRequiredDescription
browser_idstringrequiredThe GTmetrix browser ID.
GET
gtmetrix_list_simulated_devices
List GTmetrix simulated devices that can be used for tests.

/simulated-devices

GET
gtmetrix_get_simulated_device
Get a single GTmetrix simulated device by ID.

/simulated-devices/{simulated_device_id}

1 parameter
ParamTypeRequiredDescription
simulated_device_idstringrequiredThe GTmetrix simulated device ID.
GET
gtmetrix_list_tests
List GTmetrix tests for the connected account.

/tests

23 parameters
ParamTypeRequiredDescription
page_sizeintegeroptionalThe number of results to return per page.
page_numberintegeroptionalThe page number of results to return.
sortarrayoptionalThe GTmetrix test sort directives to apply.
filter_boolstringoptionalThe boolean connector used between GTmetrix filters.
sourcesarrayoptionalThe GTmetrix test source filters to apply.
statesarrayoptionalThe GTmetrix test states to include.
location_idsarrayoptionalThe GTmetrix location IDs to include in the test list.
browser_idsarrayoptionalThe GTmetrix browser IDs to include in the test list.
created_eqintegeroptionalA UNIX timestamp in seconds returned by the GTmetrix API.
created_gtintegeroptionalA UNIX timestamp in seconds returned by the GTmetrix API.
created_gteintegeroptionalA UNIX timestamp in seconds returned by the GTmetrix API.
created_ltintegeroptionalA UNIX timestamp in seconds returned by the GTmetrix API.
created_lteintegeroptionalA UNIX timestamp in seconds returned by the GTmetrix API.
started_eqintegeroptionalA UNIX timestamp in seconds returned by the GTmetrix API.
started_gtintegeroptionalA UNIX timestamp in seconds returned by the GTmetrix API.
started_gteintegeroptionalA UNIX timestamp in seconds returned by the GTmetrix API.
started_ltintegeroptionalA UNIX timestamp in seconds returned by the GTmetrix API.
started_lteintegeroptionalA UNIX timestamp in seconds returned by the GTmetrix API.
finished_eqintegeroptionalA UNIX timestamp in seconds returned by the GTmetrix API.
finished_gtintegeroptionalA UNIX timestamp in seconds returned by the GTmetrix API.
finished_gteintegeroptionalA UNIX timestamp in seconds returned by the GTmetrix API.
finished_ltintegeroptionalA UNIX timestamp in seconds returned by the GTmetrix API.
finished_lteintegeroptionalA UNIX timestamp in seconds returned by the GTmetrix API.
GET
gtmetrix_get_test
Get the current state of a GTmetrix test and detect when it has completed.

/tests/{test_id}

1 parameter
ParamTypeRequiredDescription
test_idstringrequiredThe GTmetrix test ID.
GET
gtmetrix_list_pages
List GTmetrix pages associated with the connected account.

/pages

18 parameters
ParamTypeRequiredDescription
page_sizeintegeroptionalThe number of results to return per page.
page_numberintegeroptionalThe page number of results to return.
sortarrayoptionalThe GTmetrix page sort directives to apply.
filter_boolstringoptionalThe boolean connector used between GTmetrix filters.
location_idsarrayoptionalThe GTmetrix location IDs to include in the page list.
browser_idsarrayoptionalThe GTmetrix browser IDs to include in the page list.
monitoredarrayoptionalThe GTmetrix monitored frequency filters to apply.
urlsarrayoptionalThe GTmetrix page URLs to filter by.
created_eqintegeroptionalA UNIX timestamp in seconds returned by the GTmetrix API.
created_gtintegeroptionalA UNIX timestamp in seconds returned by the GTmetrix API.
created_gteintegeroptionalA UNIX timestamp in seconds returned by the GTmetrix API.
created_ltintegeroptionalA UNIX timestamp in seconds returned by the GTmetrix API.
created_lteintegeroptionalA UNIX timestamp in seconds returned by the GTmetrix API.
latest_report_time_eqintegeroptionalA UNIX timestamp in seconds returned by the GTmetrix API.
latest_report_time_gtintegeroptionalA UNIX timestamp in seconds returned by the GTmetrix API.
latest_report_time_gteintegeroptionalA UNIX timestamp in seconds returned by the GTmetrix API.
latest_report_time_ltintegeroptionalA UNIX timestamp in seconds returned by the GTmetrix API.
latest_report_time_lteintegeroptionalA UNIX timestamp in seconds returned by the GTmetrix API.
GET
gtmetrix_get_page
Get a single GTmetrix page by slug.

/pages/{page_id}

1 parameter
ParamTypeRequiredDescription
page_idstringrequiredThe GTmetrix page slug identifier.
GET
gtmetrix_list_page_reports
List GTmetrix reports associated with a single page.

/pages/{page_id}/reports

4 parameters
ParamTypeRequiredDescription
page_idstringrequiredThe GTmetrix page slug identifier.
page_sizeintegeroptionalThe number of results to return per page.
page_numberintegeroptionalThe page number of results to return.
sortarrayoptionalThe GTmetrix page report sort directives to apply.
GET
gtmetrix_get_latest_page_report
Get the latest GTmetrix report associated with a page.

/pages/{page_id}/latest-report

1 parameter
ParamTypeRequiredDescription
page_idstringrequiredThe GTmetrix page slug identifier.
GET
gtmetrix_get_report
Get a single GTmetrix report by slug.

/reports/{report_slug}

1 parameter
ParamTypeRequiredDescription
report_slugstringrequiredThe GTmetrix report slug identifier.