# GTmetrix

GTmetrix is a performance testing and monitoring tool that analyzes website speed, provides detailed performance reports, and helps optimize web applications for better user experience.

- **Category:** developer tools
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 20
- **Triggers:** 0
- **Slug:** `GTMETRIX`
- **Version:** 20260223_00

## Tools

### Delete Page

**Slug:** `GTMETRIX_DELETE_PAGE`

Tool to delete a specific page in GTmetrix. Use when you need to permanently remove a page resource.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page_id` | string | Yes | Page slug identifier for the page to be deleted |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Report

**Slug:** `GTMETRIX_DELETE_REPORT`

Tool to delete a GTmetrix report. Use when you need to remove an existing performance report from GTmetrix.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `report_id` | string | Yes | Unique identifier (slug) of the report to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Browser Details

**Slug:** `GTMETRIX_GET_BROWSER`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `browser_id` | string | Yes | The browser ID to retrieve details for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Browsers

**Slug:** `GTMETRIX_GET_BROWSERS`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Location Details

**Slug:** `GTMETRIX_GET_LOCATION`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `location_id` | string | Yes | The location ID to retrieve details for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Locations

**Slug:** `GTMETRIX_GET_LOCATIONS`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Page Details

**Slug:** `GTMETRIX_GET_PAGE`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page_id` | string | Yes | The page slug identifier used to retrieve a specific page resource |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Page Latest Report

**Slug:** `GTMETRIX_GET_PAGE_LATEST_REPORT`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page_id` | string | Yes | Page slug identifier - the unique ID of the monitored page to retrieve the latest report for. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Page Reports

**Slug:** `GTMETRIX_GET_PAGE_REPORTS`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | Sort by report attributes: 'created', 'expires', 'performance_score', 'structure_score'. Prepend '-' for reverse sorting (e.g., '-created'). |
| `filter` | string | No | Filter by browser, location, gtmetrix_grade, source, created, expires, and boolean conditions. |
| `page_id` | string | Yes | Page slug identifier for the monitored page (e.g., '1gdDYk09'). |
| `page_size` | integer | No | Size of page for paginated results. Must be between 1 and 500. |
| `page_number` | integer | No | Page number of results to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Pages

**Slug:** `GTMETRIX_GET_PAGES`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | Sort by page attributes (created, latest_report_time). Prepend '-' for reverse order (e.g., '-created' for newest first). |
| `filter` | string | No | Filter results by url, location, browser, created, latest_report, latest_report_time, or monitored status. |
| `page_size` | integer | No | Page size for paginated results. Maximum: 500, Minimum: 1. |
| `page_number` | integer | No | Page number of results to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Report

**Slug:** `GTMETRIX_GET_REPORT`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `report_id` | string | Yes | Report slug identifier - the unique ID of the report to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Report Resource

**Slug:** `GTMETRIX_GET_REPORT_RESOURCE`

Tool 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Simulated Device

**Slug:** `GTMETRIX_GET_SIMULATED_DEVICE`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `simulated_device_id` | string | Yes | The simulated device ID to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Simulated Devices

**Slug:** `GTMETRIX_GET_SIMULATED_DEVICES`

Tool to retrieve the list of simulated devices available in GTmetrix. Use when you need to see available device profiles for testing.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get API Account Status

**Slug:** `GTMETRIX_GET_STATUS`

Tool to retrieve the current API account state and remaining credits. Use to check available API credits, refill schedule, and account features.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Test Details

**Slug:** `GTMETRIX_GET_TEST`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `test_id` | string | Yes | The unique test identifier |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Tests

**Slug:** `GTMETRIX_GET_TESTS`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | Sort results by test attributes (created, started, finished). Prepend with '-' for reverse sorting. Example: '-created' for newest first. |
| `page_size` | integer | No | Maximum page size for paginated results. Range: 1-500. |
| `page_number` | integer | No | Page number of results to retrieve. |
| `filter_state` | string | No | Filter results by test state: 'queued', 'started', 'error', or 'completed'. |
| `filter_browser` | string | No | Filter results by browser ID used in tests. |
| `filter_created` | string | No | Filter results by creation timestamp (Unix timestamp). |
| `filter_started` | string | No | Filter results by start timestamp (Unix timestamp). |
| `filter_finished` | string | No | Filter results by finish timestamp (Unix timestamp). |
| `filter_location` | string | No | Filter results by test location ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retest Page

**Slug:** `GTMETRIX_RETEST_PAGE`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page_id` | string | Yes | Page slug identifier for the page to retest |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retest Report

**Slug:** `GTMETRIX_RETEST_REPORT`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `report_id` | string | Yes | Report slug identifier for the report to retest |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Start Test

**Slug:** `GTMETRIX_START_TEST`

Tool 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |