Skip to main content
GTmetrix logo
  • Category: developer tools
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 20
  • Triggers: 0
  • Slug: GTMETRIX
  • Version: 20261101_00

Tools

Slug: GTMETRIX_DELETE_PAGEPermanently delete a specific GTmetrix page, including all its reports and associated history.

Input Parameters

string
required
Page slug identifier for the page to be deleted

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GTMETRIX_DELETE_REPORTPermanently delete a GTmetrix report and all of its resources.

Input Parameters

string
required
Unique identifier (slug) of the report to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GTMETRIX_GET_BROWSERTool to retrieve browser details from GTmetrix. Use when you need to get information about a specific browser including name, platform, supported features, and testing capabilities.

Input Parameters

string
required
The browser ID to retrieve details for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GTMETRIX_GET_BROWSERSTool to retrieve the list of available browsers for GTmetrix performance tests. Use when you need to see which browsers are available and their testing capabilities.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GTMETRIX_GET_LOCATIONTool to retrieve location details from GTmetrix. Use when you need to get information about a specific GTmetrix test location including name, region, browser support, IP addresses, and access permissions.

Input Parameters

string
required
The location ID to retrieve details for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GTMETRIX_GET_LOCATIONSTool to retrieve the list of available GTmetrix test locations. Use when you need to see which locations are available for testing and their details including supported browsers and access status.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GTMETRIX_GET_PAGETool to retrieve page details from the user’s GTmetrix account. Use when you need to get comprehensive page information including URL, testing configuration, and monitoring frequency.

Input Parameters

string
required
The page slug identifier used to retrieve a specific page resource

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GTMETRIX_GET_PAGE_LATEST_REPORTRetrieve the latest test report for a GTmetrix page, including available performance metrics and timing data.

Input Parameters

string
required
Page slug identifier - the unique ID of the monitored page to retrieve the latest report for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GTMETRIX_GET_PAGE_REPORTSRetrieve a paginated list of historical performance reports for a GTmetrix page, with sorting options. A filter string is sent as a single filter parameter.

Input Parameters

string
Sort by report attributes: ‘created’, ‘expires’, ‘performance_score’, ‘structure_score’. Prepend ’-’ for reverse sorting (e.g., ‘-created’).
string
Filter by browser, location, gtmetrix_grade, source, created, expires, and boolean conditions.
string
required
Page slug identifier for the monitored page (e.g., ‘1gdDYk09’).
integer
Size of page for paginated results. Must be between 1 and 500.
integer
Page number of results to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GTMETRIX_GET_PAGESRetrieve a paginated list of GTmetrix account pages, including their configurations and latest report identifiers. Only pages with at least one valid report are returned.

Input Parameters

string
Sort by page attributes (created, latest_report_time). Prepend ’-’ for reverse order (e.g., ‘-created’ for newest first).
string
Filter results by url, location, browser, created, latest_report, latest_report_time, or monitored status.
integer
Page size for paginated results. Maximum: 500, Minimum: 1.
integer
Page number of results to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GTMETRIX_GET_REPORTRetrieve a GTmetrix test report by ID, including selected performance metrics, timing data, and resource links.

Input Parameters

string
required
Report slug identifier - the unique ID of the report to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GTMETRIX_GET_REPORT_RESOURCETool to get a report resource such as screenshot, HAR file, video, PDF, or Lighthouse JSON. Use when you need to download specific report artifacts that require API authentication.

Input Parameters

string
required
Report slug identifier - the unique ID of the report.
string ("analysis_options" | "net.har" | "screenshot.jpg" | "video.mp4" | "lighthouse.json" | "report.pdf" | "pagespeed.json" | "pagespeed-files.tar" | "optimized-images.tar" | "yslow.json")
required
Report resource name to retrieve (e.g., screenshot.jpg, video.mp4, report.pdf, lighthouse.json, net.har).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GTMETRIX_GET_SIMULATED_DEVICETool to retrieve simulated device details. Use when you need information about a specific simulated device including its name, category, manufacturer, user agent, screen dimensions, and pixel ratio.

Input Parameters

string
required
The simulated device ID to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GTMETRIX_GET_SIMULATED_DEVICESTool to retrieve the list of simulated devices available in GTmetrix. Use when you need to see available device profiles for testing.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GTMETRIX_GET_STATUSTool to retrieve the current API account state and remaining credits. Use to check available API credits, refill schedule, and account features.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GTMETRIX_GET_TESTTool to retrieve test details for a specific GTMetrix test. Use when you need to check the status, configuration, or results of a previously initiated test.

Input Parameters

string
required
The unique test identifier

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GTMETRIX_GET_TESTSRetrieve a paginated, filterable list of API-sourced tests from your GTmetrix account, including their states, timestamps, and configuration details.

Input Parameters

string
Sort results by test attributes (created, started, finished). Prepend with ’-’ for reverse sorting. Example: ‘-created’ for newest first.
integer
Maximum page size for paginated results. Range: 1-500.
integer
Page number of results to retrieve.
string
Filter results by test state: ‘queued’, ‘started’, ‘error’, or ‘completed’.
string
Filter results by browser ID used in tests.
string
Filter results by creation timestamp (Unix timestamp).
string
Filter results by start timestamp (Unix timestamp).
string
Filter results by finish timestamp (Unix timestamp).
string
Filter results by test location ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GTMETRIX_RETEST_PAGETool to initiate a retest of a GTmetrix page with same parameters. Use when you need to create a new test using the same parameters as the most recent report for this page.

Input Parameters

string
required
Page slug identifier for the page to retest

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GTMETRIX_RETEST_REPORTTool to initiate a retest of a completed GTmetrix report with same parameters. Use when you need to rerun a test using the exact same analysis parameters as the original test.

Input Parameters

string
required
Report slug identifier for the report to retest

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GTMETRIX_START_TESTTool to start a new GTmetrix test for a specified URL. Use when you need to analyze website performance with configurable options like location, browser, and throttling.

Input Parameters

array
Custom DNS host and IP for testing (e.g., [‘example.com:1.2.3.4’]).
string
required
The URL to test. Must be a valid HTTP or HTTPS URL.
integer ("0" | "1")
Enable video generation: 0 for disabled, 1 for enabled.
string
Report type: ‘lighthouse’ for Lighthouse only, ‘legacy’ for PageSpeed/YSlow, ‘lighthouse,legacy’ for both, ‘none’ for metrics-only.
integer ("0" | "1")
Enable AdBlock: 0 for disabled, 1 for enabled.
string
Browser identifier for test execution (e.g., ‘chrome’, ‘firefox’).
array
Cookies using ‘name=value’ syntax (e.g., [‘session_id=abc123’, ‘user=john’]).
string
Location identifier for test execution (e.g., ‘us-east1’, ‘europe-west1’).
string
Connection throttling in Kbps and latency in ms (e.g., ‘1500/50’ for 1.5 Mbps and 50ms latency).
array
Only load resources matching these URL patterns (e.g., [‘.example.com/’]).
array
Prevent loading resources matching these URL patterns (e.g., [‘.ads.com/’]).
integer ("1" | "6" | "12" | "24")
Report retention period in months. Must be one of: 1, 6, 12, or 24.
string
Custom User Agent string to use for the test.
integer ("0" | "1")
Stop test at window.onload event: 0 for disabled, 1 for enabled.
number
Device pixel ratio. Must be between 1 and 5.
integer
Viewport width in pixels. Default is 1366.
integer
Viewport height in pixels. Default is 768.
integer ("0" | "1")
Swap viewport width and height (rotate): 0 for disabled, 1 for enabled.
string
Device simulation identifier (e.g., ‘iPhone 12’, ‘Samsung Galaxy S21’).
string
Password for HTTP access authentication.
string
Username for HTTP access authentication.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not