NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
GTmetrix connects to a Nagent workspace with an API key. Once it is connected, agents can call 20 GTmetrix actions, such as "Get Browser Details", "Get Browsers" and "Get Location Details". Nothing is enabled on connect: each action is allowed one at a time, and an action with side effects runs or waits for a person according to the agent's level.
Every operation an agent can call against GTmetrix, with input parameters and output schema.
GTMETRIX_DELETE_PAGETool to delete a specific page in GTmetrix. Use when you need to permanently remove a page resource.
Input parameters
Page slug identifier for the page to be deleted
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GTMETRIX_DELETE_REPORTTool to delete a GTmetrix report. Use when you need to remove an existing performance report from GTmetrix.
Input parameters
Unique identifier (slug) of the report to delete
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
The browser ID to retrieve details for
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
The location ID to retrieve details for
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
The page slug identifier used to retrieve a specific page resource
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GTMETRIX_GET_PAGE_LATEST_REPORTTool to retrieve the most recent test report for a monitored page in GTmetrix. Use when you need to get the latest performance metrics and timing data for a specific page.
Input parameters
Page slug identifier - the unique ID of the monitored page to retrieve the latest report for.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GTMETRIX_GET_PAGE_REPORTSTool to retrieve the report list associated with a monitored page in GTmetrix. Use when you need to access historical performance data for a specific page. Supports pagination, sorting, and filtering.
Input parameters
Sort by report attributes: 'created', 'expires', 'performance_score', 'structure_score'. Prepend '-' for reverse sorting (e.g., '-created').
Filter by browser, location, gtmetrix_grade, source, created, expires, and boolean conditions.
Page slug identifier for the monitored page (e.g., '1gdDYk09').
Size of page for paginated results. Must be between 1 and 500.
Page number of results to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GTMETRIX_GET_PAGESTool to retrieve the page list from your GTmetrix account. Returns a paginated collection of monitored pages with their configurations and latest report information. Use when you need to view all monitored pages, check page configurations, or access latest report data.
Input parameters
Sort by page attributes (created, latest_report_time). Prepend '-' for reverse order (e.g., '-created' for newest first).
Filter results by url, location, browser, created, latest_report, latest_report_time, or monitored status.
Page size for paginated results. Maximum: 500, Minimum: 1.
Page number of results to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GTMETRIX_GET_REPORTTool to retrieve a GTmetrix test report by its identifier. Use when you need to get comprehensive performance metrics, timing data, and links to resources for a specific report.
Input parameters
Report slug identifier - the unique ID of the report to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Report slug identifier - the unique ID of the report.
Report resource name to retrieve (e.g., screenshot.jpg, video.mp4, report.pdf, lighthouse.json, net.har).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
The simulated device ID to retrieve
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
The unique test identifier
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GTMETRIX_GET_TESTSTool to retrieve the test list from your GTmetrix account with pagination and filtering support. Use when you need to view tests with their state, timestamps, and configuration details.
Input parameters
Sort results by test attributes (created, started, finished). Prepend with '-' for reverse sorting. Example: '-created' for newest first.
Maximum page size for paginated results. Range: 1-500.
Page number of results to retrieve.
Filter results by test state: 'queued', 'started', 'error', or 'completed'.
Filter results by browser ID used in tests.
Filter results by creation timestamp (Unix timestamp).
Filter results by start timestamp (Unix timestamp).
Filter results by finish timestamp (Unix timestamp).
Filter results by test location ID.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Page slug identifier for the page to retest
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Report slug identifier for the report to retest
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Custom DNS host and IP for testing (e.g., \['example.com:1.2.3.4'\]).
The URL to test. Must be a valid HTTP or HTTPS URL.
Enable video generation: 0 for disabled, 1 for enabled.
Report type: 'lighthouse' for Lighthouse only, 'legacy' for PageSpeed/YSlow, 'lighthouse,legacy' for both, 'none' for metrics-only.
Enable AdBlock: 0 for disabled, 1 for enabled.
Browser identifier for test execution (e.g., 'chrome', 'firefox').
Cookies using 'name=value' syntax (e.g., \['session_id=abc123', 'user=john'\]).
Location identifier for test execution (e.g., 'us-east1', 'europe-west1').
Connection throttling in Kbps and latency in ms (e.g., '1500/50' for 1.5 Mbps and 50ms latency).
Only load resources matching these URL patterns (e.g., \['*.example.com/*'\]).
Prevent loading resources matching these URL patterns (e.g., \['*.ads.com/*'\]).
Report retention period in months. Must be one of: 1, 6, 12, or 24.
Custom User Agent string to use for the test.
Stop test at window.onload event: 0 for disabled, 1 for enabled.
Device pixel ratio. Must be between 1 and 5.
Viewport width in pixels. Default is 1366.
Viewport height in pixels. Default is 768.
Swap viewport width and height (rotate): 0 for disabled, 1 for enabled.
Device simulation identifier (e.g., 'iPhone 12', 'Samsung Galaxy S21').
Password for HTTP access authentication.
Username for HTTP access authentication.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
Agents can call 20 GTmetrix actions on Nagent, including "Get Browser Details", "Get Browsers" and "Get Location Details". Get Browser Details: Retrieve browser details from GTmetrix. Each action is listed on this page with its input parameters and its output.
GTmetrix connects with an API key, under your workspace's own connection. Nothing is enabled on connect: each action is allowed one at a time and can be scoped to the agents that need it.
Get Browser Details takes 1 required input: browser_id. It returns data, error and successful.