GTmetrix REST API v2.0

https://gtmetrix.com/api/docs/2.0
Admin
The GTmetrix API offers developers an easy way to integrate GTmetrix performance testing services...
Tokens:31,076
Snippets:129
Trust Score:9.5
Update:8 months ago
Show doc for...
Tokens:
Raw
### Start GTmetrix Test Request (cURL)

Source: https://gtmetrix.com/api/docs/2.0/index

Example using cURL to initiate a new page test via the GTmetrix API. This demonstrates the POST request method, required headers, and the structure of the request body, including URL, location, and browser parameters.

```bash
curl -u e8ddc55d93eb0e8281b255ea236dcc4f: \
    -X POST -H Content-Type:application/vnd.api+json \
    https://gtmetrix.com/api/2.0/tests \
    -d '
{
  "data": {
    "type": "test",
    "attributes": {
      "url":      "https://www.gtmetrix.com",
      "location": "{location_id}",
      "browser":  "{browser_id}",
      "adblock":  1
      ...
    }
  }
}'
```

--------------------------------

### Get a list of browsers

Source: https://gtmetrix.com/api/docs/2.0/index

Retrieves a list of all available test browsers that you can use for performance testing. This endpoint provides basic information about each browser.

```APIDOC
## GET /api/2.0/browsers

### Description
Get a list of test browsers currently available to you. Note: If you are looking to test your page with a diverse set of screen resolutions, launch a simulated device test (PRO only). Refer to simulated devices list for more information.

### Method
GET

### Endpoint
/api/2.0/browsers

### Parameters
#### Query Parameters
None

### Request Example
```json
{
  "example": ""
}
```

### Response
#### Success Response (200)
- **data** (array of objects) - A list of Browsers

#### Response Example
```json
{
  "data": [
    {
      "type": "browser",
      "id":   "browser_id",
      "attributes": {
        "name":       "Chrome",
        "default":    true,
        "platform":   "desktop",
        "adblock":    true,
        "cookies":    true,
        "dns":        true,
        "filtering":  true,
        "http_auth":  true,
        "resolution": true,
        "throttle":   true,
        "user_agent": true,
        "video":      true,
        "lighthouse": true,
        "device":     ""
      }
    },
    {
      "...": "..."
    }
  ]
}
```
```

--------------------------------

### Get a list of simulated devices

Source: https://gtmetrix.com/api/docs/2.0/index

Retrieves a comprehensive list of all simulated devices available for testing. This allows you to understand the various device profiles you can use to simulate different user experiences.

```APIDOC
## GET /api/2.0/simulated-devices

### Description
Get a full list of simulated devices and their details. See reference values for a full list. Use the `simulate_device` option in Start a test to simulate the display of your site with a specific device.

### Method
GET

### Endpoint
/api/2.0/simulated-devices

### Parameters
#### Query Parameters
None

### Request Example
```json
{
  "example": ""
}
```

### Response
#### Success Response (200)
- **data** (array of objects) - A list of Simulated Devices

#### Response Example
```json
{
  "data": [
    {
      "type": "simulated_device",
      "id":   "device_id",
      "attributes": {
        "name": "Desktop",
        "width": 1024,
        "height": 768,
        "pixel_ratio": 1
      }
    },
    {
      "...": "..."
    }
  ]
}
```
```

--------------------------------

### GET /api/2.0/pages

Source: https://gtmetrix.com/api/docs/2.0/index

Retrieves a paginated list of all pages belonging to your account that have at least one valid report.

```APIDOC
## GET /api/2.0/pages

### Description
Retrieves a paginated list of all pages belonging to your account that have at least one valid report. This is similar to the GTmetrix Dashboard view.

### Method
GET

### Endpoint
/api/2.0/pages

### Parameters
#### Query Parameters
- **sort** (string) - Optional - Sort the list by page attribute. Supported attributes: **created**, **latest_report_time**. Prepend with '-' for descending order. Comma-separated for multiple sorts. Defaults to **created** (descending).
- **filter[attribute]** (string) - Optional - Filter the list by page attribute value. Supported attributes: **url**, **monitored**, **browser**, **location**, and numeric attributes with operators (:eq, :lt, :lte, :gt, :gte). Fuzzy search for 'url'. Multiple values allowed. Use **:bool** (AND/OR) to specify the connector between filters. Defaults to AND.
- **page[size]** (integer) - Optional - Set the page size. Default 10, max 500.
- **page[number]** (integer) - Optional - Set the page number.

### Request Example
```bash
GET /api/2.0/pages?sort=created&filter[monitored]=hourly&page[number]=2&page[size]=25
```

### Response
#### Success Response (200)
- Returns a paginated list of page objects. Each object contains similar attributes as the response for `GET /api/2.0/pages/{page_id}`.

#### Response Example
```json
{
  "data": [
    {
      "type": "page",
      "id": "page_id_1",
      "attributes": {
        "url": "https://example.com/page1",
        "created": 1651537199,
        "browser": "browser_id_1",
        "location": "location_id_1",
        "latest_report_time": 1663780062,
        "latest_report": "report_id_1",
        "report_count": 3,
        "monitored": "daily"
      },
      "links": {
        "retest": "https://gtmetrix.com/api/2.0/pages/page_id_1/retest",
        "latest_report": "https://gtmetrix.com/api/2.0/pages/page_id_1/latest-report",
        "reports": "https://gtmetrix.com/api/2.0/pages/page_id_1/reports",
        "location": "https://gtmetrix.com/api/2.0/locations/location_id_1",
        "browser": "https://gtmetrix.com/api/2.0/browsers/browser_id_1"
      }
    }
    // ... more page objects
  ],
  "meta": {
    "current_page": 1,
    "per_page": 10,
    "total_pages": 5,
    "total_count": 48
  }
}
```
```

--------------------------------

### POST /api/2.0/pages/{page_id}/retest

Source: https://gtmetrix.com/api/docs/2.0/index

Initiates a retest for a specified page, using the same settings as the last test. This is equivalent to starting a new test with existing parameters.

```APIDOC
## POST /api/2.0/pages/{page_id}/retest

### Description
Initiates a retest for a specified page, using the same settings as the last test. This is equivalent to starting a new test with existing parameters.

### Method
POST

### Endpoint
/api/2.0/pages/{page_id}/retest

#### Path Parameters
- **page_id** (string) - Required - The unique identifier of the page to retest.

### Response
#### Success Response (202)
- **Location** header contains the URL to the new test resource (e.g., `/api/2.0/tests/{test_id}`). The response body is identical to starting a new test.

#### Response Example
```
HTTP/1.1 202 Accepted
Location: /api/2.0/tests/{test_id}

...
```

#### Possible errors
HTTP status | Error code | Error message
---|---|---
404 | E40404 | Page not found
```

--------------------------------

### GET /api/2.0/locations

Source: https://gtmetrix.com/api/docs/2.0/index

Retrieves a list of available test locations.

```APIDOC
## GET /api/2.0/locations

### Description
Retrieves a list of available test locations.

### Method
GET

### Endpoint
/api/2.0/locations

### Response
#### Success Response (200)
- **data** (array of objects) - A list of Locations.

#### Response Example
```json
{
  "data": [
    {
      "type": "location",
      "id":   "{location_id}",
      "attributes": {
        "name":     "Sydney, Australia",
        "region":   "Asia Pacific",
        "default":  false,
        "account_has_access": true,
        "browsers": [ "{browser_id}", ... ],
        "ips": [ "{ip_address}", ... ]
      }
    },
    { ... },
    ... 
  ]
}
```
```

--------------------------------

### GET /api/2.0/pages

Source: https://gtmetrix.com/api/docs/2.0/index

Retrieves a paginated list of all pages monitored by the API. Includes details like URL, creation date, browser, location, and latest report information.

```APIDOC
## GET /api/2.0/pages

### Description
Retrieves a paginated list of all pages monitored by the API. Includes details like URL, creation date, browser, location, and latest report information.

### Method
GET

### Endpoint
/api/2.0/pages

### Query Parameters
- **page[number]** (integer) - Optional - The page number to retrieve for pagination.
- **page[size]** (integer) - Optional - The number of items to return per page.

### Response
#### Success Response (200)
- **data** (array of objects) - A paginated array of page objects.
  - **data.type** (string) - The type of the resource, always "page".
  - **data.id** (string) - The unique identifier for the page.
  - **data.attributes** (object) - Contains details about the page.
    - **url** (string) - The URL of the page.
    - **created** (integer) - Timestamp of when the page was added.
    - **browser** (string) - The ID of the browser used for testing.
    - **location** (string) - The ID of the location used for testing.
    - **latest_report_time** (integer) - Timestamp of the latest report.
    - **latest_report** (string) - The ID of the latest report.
    - **report_count** (integer) - The total number of reports for the page.
    - **monitored** (string) - Indicates if the page is actively monitored ("yes" or "no").
  - **data.links** (object) - Links related to the page resource.
    - **retest** (string) - URL to retest the page.
    - **latest_report** (string) - URL to the latest report.
    - **reports** (string) - URL to all reports for the page.
    - **location** (string) - URL to the location details.
    - **browser** (string) - URL to the browser details.
- **links** (object) - Pagination links.
  - **prev** (string) - URL to the previous page of results.
  - **next** (string) - URL to the next page of results.
- **meta** (object) - Metadata for the response.
  - **curr_page** (string) - The current page number.

#### Response Example
```json
{
  "data": [
    {
      "data": {
        "type": "page",
        "id": "{page_id}",
        "attributes": {
          "url": "https://gtmetrix.com/",
          "created": 1651537199,
          "browser": "{browser_id}",
          "location": "{location_id}",
          "latest_report_time": 1663780062,
          "latest_report": "{report_id}",
          "report_count": 5,
          "monitored": "no"
        },
        "links": {
          "retest": "https://gtmetrix.com/api/2.0/pages/{page_id}/retest",
          "latest_report": "https://gtmetrix.com/api/2.0/pages/{page_id}/latest-report",
          "reports": "https://gtmetrix.com/api/2.0/pages/{page_id}/reports",
          "location": "https://gtmetrix.com/api/2.0/locations/{location_id}",
          "browser": "https://gtmetrix.com/api/2.0/browsers/{browser_id}"
        }
      }
    }
  ],
  "links": {
    "prev": "/api/2.0/pages?page[number]=2",
    "next": "/api/2.0/pages?page[number]=4"
  },
  "meta": {
    "curr_page": 3
  }
}
```

#### Possible errors
HTTP status | Error code | Error message
---|---|---
400 | E40005 | Invalid query parameter
400 | E40006 | Invalid query parameter (unknown filter value)
400 | E40007 | Invalid query parameter (invalid sort parameter value)
400 | E40008 | Invalid query parameter (invalid page[size] or page[number] value)
```

--------------------------------

### Get List of Simulated Devices (cURL)

Source: https://gtmetrix.com/api/docs/2.0/index

Retrieves a list of all available simulated devices that can be used for performance testing. This endpoint requires authentication and returns a JSON object containing an array of device details.

```cURL
curl -u e8ddc55d93eb0e8281b255ea236dcc4f: \
    https://gtmetrix.com/api/2.0/browsers
```

--------------------------------

### Get Simulated Device Details

Source: https://gtmetrix.com/api/docs/2.0/index

Retrieves detailed information about a specific simulated device using its unique ID. This is useful for understanding the exact specifications of a device for testing.

```APIDOC
## GET /api/2.0/simulated-devices/{simulated_device_id}

### Description
Retrieves detailed information about a specific simulated device using its unique ID. This is useful for understanding the exact specifications of a device for testing.

### Method
GET

### Endpoint
/api/2.0/simulated-devices/{simulated_device_id}

### Parameters
#### Path Parameters
- **simulated_device_id** (string) - Required - The unique identifier of the simulated device.

#### Query Parameters
None

### Request Example
```bash
curl -u YOUR_API_KEY: \
    https://gtmetrix.com/api/2.0/simulated-devices/iphone_xs_max
```

### Response
#### Success Response (200)
- **data** (object) - A simulated device object:
  - **id** (string) - The simulated device ID.
  - **type** (string) - The resource type, always "simulated_device".
  - **attributes** (object) - Contains detailed properties of the device:
    - **category** (string) - The category of the device ("phone" or "tablet").
    - **dppx** (number) - The device's pixel ratio (1-5).
    - **height** (integer) - The device's display height in pixels.
    - **manufacturer** (string) - The device's manufacturer.
    - **name** (string) - The device's name.
    - **user_agent** (string) - The browser user-agent string used for the analysis.
    - **width** (integer) - The device's display width in pixels.

#### Response Example
```json
{
  "data": {
    "id": "iphone_xs_max",
    "type": "simulated_device",
    "attributes": {
        "category": "phone",
        "dppx": 3,
        "height": 896,
        "manufacturer": "Apple",
        "name": "iPhone 11 Pro/11 Pro Max/12 Pro Max",
        "user_agent": "Mozilla/5.0 (iPhone; CPU iPhone OS 14_5 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.5 Mobile/15E148 Safari/604.1 GTmetrix",
        "width": 414
    }
  }
}
```

#### Error Response (404)
- **error** (object) - Contains error details:
  - **code** (string) - Error code (e.g., "E40408").
  - **message** (string) - Error message (e.g., "simulated device not found").
```

--------------------------------

### Get a list of tests

Source: https://gtmetrix.com/api/docs/2.0/index

Retrieves a paginated list of all tests associated with your account. Tests are retained for 24 hours, while GTmetrix reports are kept for 1 month by default.

```APIDOC
## GET /api/2.0/tests

### Description
Get a paginated list of all the tests belonging to your account. Note that the tests are only retained for 24 hours. The GTmetrix report for the URL will be retained for 1 month by default unless higher report retention was specified when generating the test.
See also: Start a test

### Method
GET

### Endpoint
/api/2.0/tests

### Parameters
#### Query Parameters
- **sort** (string) - Optional - Sort the list by test attribute. Supported attributes: `created`, `started`, `finished`. Prepend with `-` for descending sort. Defaults to `created` (ascending). Multiple sorting can be done using comma-separated values or by passing the parameter multiple times.
- **filter** (string) - Optional - Filter the list by test attribute value. By default, only tests with attribute `source = api` will be returned. Supported attributes: `state`, `source`, `created`, `started`, `finished`, `browser`, `location`. Supported numeric operators (append to attribute name): `:eq`, `:lt`, `:lte`, `:gt`, `:gte`. Multiple values are allowed for the same filter name. The special filter name `:bool` can be used to specify the boolean connector between filters (`AND` (default), `OR`).
- **page[size]** (integer) - Optional - Set the page size (default 50, max 500).
- **page[number]** (integer) - Optional - Set the page number.

### Request Example
```bash
curl -u e8ddc55d93eb0e8281b255ea236dcc4f: \
    https://gtmetrix.com/api/2.0/tests?sort=created&filter[state]=completed&page[number]=3
```

### Response
#### Success Response (200)
- **data** (array of objects) - A paginated array of Tests.
- **links.* ** (string) - Pagination links to navigate the result pages.
- **meta.curr_page** (string) - The current page from pagination.

#### Response Example
```json
{
  "data": [
    {
      "type": "test",
      "id":   "{test_id}",
      "attributes": {
        "report":   "{report_id}",
        "url":      "https://gtmetrix.com",
        "page":     "{page_id}",
        "source":   "api",
        "location": "{location_id}",
        "browser":  "{browser_id}",
        "state":    "completed",
        "created":  1617680457,
        "started":  1617680459,
        "finished": 1617680502
      },
      "links": {
        "report": "https://gtmetrix.com/api/2.0/reports/{report_id}",
        "location": "https://gtmetrix.com/api/2.0/locations/{location_id}",
        "browser":  "https://gtmetrix.com/api/2.0/browsers/{browser_id}"
      }
    },
    { ... },
    ... 
    { ... }
  ],
  "links": {
    "prev":  "/api/2.0/tests?sort=created&page[number]=2",
    "next":  "/api/2.0/tests?sort=created&page[number]=4"
  },
  "meta": {
    "curr_page": 3
  }
}
```

#### Possible errors
HTTP status | Error code | Error message  
---|---|---  
400 | E40005 | Invalid query parameter  
400 | E40006 | Invalid query parameter (unknown filter value)  
400 | E40007 | Invalid query parameter (invalid sort parameter value)  
400 | E40008 | Invalid query parameter (invalid page[size] or page[number] value)  
402 | E40201 | Insufficient API credits for this request  
415 | E41500 | Unsupported media type (Request must use Content-Type: application/vnd.api+json)  
429 | E42900 | Too many tests pending (Please retry after your existing tests have completed)
```

--------------------------------

### GET /api/2.0/pages/{page_id}

Source: https://gtmetrix.com/api/docs/2.0/index

Retrieves details for a specific page, including its URL, creation time, associated browser and location, and report information.

```APIDOC
## GET /api/2.0/pages/{page_id}

### Description
Retrieves details for a specific page, including its URL, creation time, associated browser and location, and report information.

### Method
GET

### Endpoint
/api/2.0/pages/{page_id}

### Parameters
#### Path Parameters
- **page_id** (string) - Required - The unique identifier for the page.

### Request Example
```bash
curl -u e8ddc55d93eb0e8281b255ea236dcc4f: \
    https://gtmetrix.com/api/2.0/pages/{page_id}
```

### Response
#### Success Response (200)
- **data.type** (string) - The resource type. Always has the value "page".
- **data.id** (string) - The page ID.
- **data.attributes.url** (string) - The URL of the page tested.
- **data.attributes.created** (integer) - Time when this page was created (unix timestamp).
- **data.attributes.browser** (string) - The Browser ID set for the analysis options.
- **data.attributes.location** (string) - The Location ID set for the analysis options.
- **data.attributes.latest_report_time** (integer) - Time when the latest report was generated (unix timestamp).
- **data.attributes.latest_report** (string) - ID of the latest report generated for this page.
- **data.attributes.report_count** (integer) - Number of valid reports currently associated with this page.
- **data.attributes.monitored** (string) - Whether this page is monitored ("no", "hourly", "daily", "weekly", or "monthly").
- **data.links.retest** (string) - URL to generate a new report for this page.
- **data.links.latest_report** (string) - URL to fetch the latest report of this page.
- **data.links.reports** (string) - URL to fetch a list of reports belonging to this page.
- **data.links.location** (string) - URL of the Location used.
- **data.links.browser** (string) - URL of the Browser used.

#### Response Example
```json
{
  "data": {
    "type": "page",
    "id": "{page_id}",
    "attributes": {
      "url": "https://gtmetrix.com/",
      "created": 1651537199,
      "browser": "{browser_id}",
      "location": "{location_id}",
      "latest_report_time": 1663780062,
      "latest_report": "{report_id}",
      "report_count": 5,
      "monitored": "no"
    },
    "links": {
      "retest": "https://gtmetrix.com/api/2.0/pages/{page_id}/retest",
      "latest_report": "https://gtmetrix.com/api/2.0/pages/{page_id}/latest-report",
      "reports": "https://gtmetrix.com/api/2.0/pages/{page_id}/reports",
      "location": "https://gtmetrix.com/api/2.0/locations/{location_id}",
      "browser": "https://gtmetrix.com/api/2.0/browsers/{browser_id}"
    }
  }
}
```

#### Possible errors
- **404** - **E40402** - Page not found
```

--------------------------------

### GTmetrix API 2.0 Successful Response Example

Source: https://gtmetrix.com/api/docs/2.0/index

This code snippet demonstrates a successful API response when queuing a new test. It returns a 202 Accepted status and includes the test ID, current state, and resource links. The response also provides meta-information about API credit usage.

```http
HTTP/1.1 202 Accepted
Location: /api/2.0/tests/{test_id}

{
  "data": {
    "type": "test",
    "id":   "{test_id}",
    "attributes": {
      "source":   "api",
      "location": "{location_id}",
      "browser":  "{browser_id}",
      "state":    "queued",
      "created":  1617680457,
    }
  },
  "meta": {
    "credits_left": 121.2,
    "credits_used": 2.8
  },
  "links": {
    "self": "/api/2.0/tests/{test_id}"
  }
}


```

--------------------------------

### POST /api/2.0/reports/{report_id}/retest

Source: https://gtmetrix.com/api/docs/2.0/index

Initiates a retest of a previously generated GTmetrix report using the same page settings. This is equivalent to starting a new test with identical parameters.

```APIDOC
## POST /api/2.0/reports/{report_id}/retest

### Description
Retest a report with the same page settings. This is semantically identical to starting a new test using the same parameters as the test that generated this report, as well as retest a page endpoint.

### Method
POST

### Endpoint
/api/2.0/reports/{report_id}/retest

### Parameters
#### Path Parameters
- **report_id** (string) - Required - The report ID identifying the report.

### Request Example
```bash
curl -u e8ddc55d93eb0e8281b255ea236dcc4f: -X POST https://gtmetrix.com/api/2.0/reports/{report_id}/retest
```

### Response
#### Success Response (202 Accepted)
```
HTTP/1.1 202 Accepted
Location: /api/2.0/tests/{test_id}

...
```

The response is identical to starting a new test.

#### Possible errors
HTTP status | Error code | Error message
---|---|---
404 | E40402 | Page not found
```

--------------------------------

### Get Simulated Device Details by ID (cURL)

Source: https://gtmetrix.com/api/docs/2.0/index

Fetches detailed information about a specific simulated device using its unique ID. This is useful for understanding the exact specifications of a device for testing purposes. The response includes attributes like category, dimensions, and user agent.

```cURL
curl -u e8ddc55d93eb0e8281b255ea236dcc4f: \
    https://gtmetrix.com/api/2.0/simulated-devices/{simulated_device_id}
```

--------------------------------

### Successful Response for Listing Tests (cURL)

Source: https://gtmetrix.com/api/docs/2.0/index

Example cURL command and its successful HTTP 200 OK response when listing GTmetrix tests. The response body is a JSON object containing an array of test data, pagination links, and current page information.

```bash
curl -u e8ddc55d93eb0e8281b255ea236dcc4f: \
    https://gtmetrix.com/api/2.0/tests

HTTP/1.1 200 OK

{
  "data": [
    {
      "type": "test",
      "id":   "{test_id}",
      "attributes": {
        "report":   "{report_id}",
        "url":      "https://gtmetrix.com",
        "page":     "{page_id}",
        "source":   "api",
        "location": "{location_id}",
        "browser":  "{browser_id}",
        "state":    "completed",
        "created":  1617680457,
        "started":  1617680459,
        "finished": 1617680502
      },
      "links": {
        "report": "https://gtmetrix.com/api/2.0/reports/{report_id}",
        "location": "https://gtmetrix.com/api/2.0/locations/{location_id}",
        "browser":  "https://gtmetrix.com/api/2.0/browsers/{browser_id}"
      }
    },
    { ... },
    ...
    { ... }
  ],
  "links": {
    "prev":  "/api/2.0/tests?sort=created&page[number]=2",
    "next":  "/api/2.0/tests?sort=created&page[number]=4",
  },
  "meta": {
    "curr_page": 3
  }
}
```

--------------------------------

### Retest GTmetrix Report using cURL

Source: https://gtmetrix.com/api/docs/2.0/index

This code example shows how to retest a GTmetrix report using cURL. This operation uses the POST method and requires the report ID. It initiates a new test with the same parameters as the original report. The response includes a 202 Accepted status and a Location header pointing to the new test ID.

```bash
curl -u e8ddc55d93eb0e8281b255ea236dcc4f: -X POST \
    https://gtmetrix.com/api/2.0/reports/{report_id}/retest
```

--------------------------------

### GTmetrix API 2.0 Filmstrip Data Object (No Base64)

Source: https://gtmetrix.com/api/docs/2.0/index

This JSON object represents filmstrip data, which is a sequence of screenshots captured during page load for Lighthouse Reports. It includes the total frame count, dimensions of each frame, and an array of screenshot objects, each containing timing information and a URL to fetch the JPEG data. This example assumes the `base64=1` query parameter was not used.

```json
{
  "data": {
    "id": "{report_id}",
    "type": "filmstrip",
    "attributes": {
      "frame_count": 5,
      "frame_width": 230,
      "frame_height": 498,
      "screenshots": [
        {
          "timing": 361.590125,
          "frame_id": "0",
          "url": "https://gtmetrix.com/api/2.0/reports/{report_id}/resources/filmstrip-frame.jpg?id=0"
        },
        {
          "timing": 723.18025,
          "frame_id": "0",
          "url": "https://gtmetrix.com/api/2.0/reports/{report_id}/resources/filmstrip-frame.jpg?id=0"
        },
        {
          "timing": 1084.770375,
          "frame_id": "0",
          "url": "https://gtmetrix.com/api/2.0/reports/{report_id}/resources/filmstrip-frame.jpg?id=0"
        },
        {
          "timing": 1446.3605,
          "frame_id": "1",
          "url": "https://gtmetrix.com/api/2.0/reports/{report_id}/resources/filmstrip-frame.jpg?id=1"
        },
        {
          "timing": 1807.950625,
          "frame_id": "2",
          "url": "https://gtmetrix.com/api/2.0/reports/{report_id}/resources/filmstrip-frame.jpg?id=2"
        },
        {
          "timing": 2169.54075,
          "frame_id": "3",
          "url": "https://gtmetrix.com/api/2.0/reports/{report_id}/resources/filmstrip-frame.jpg?id=3"
        },
        {
          "timing": 2531.130875,
          "frame_id": "3",
          "url": "https://gtmetrix.com/api/2.0/reports/{report_id}/resources/filmstrip-frame.jpg?id=3"
        },
        {
          "timing": 2892.721,
          "frame_id": "4",
          "url": "https://gtmetrix.com/api/2.0/reports/{report_id}/resources/filmstrip-frame.jpg?id=4"
        }
      ]
    }
  }
}
```

--------------------------------

### Connection Throttling Options

Source: https://gtmetrix.com/api/docs/2.0/index

Provides a list of predefined connection throttling configurations that can be used for testing network conditions.

```APIDOC
## GET /websites/gtmetrix_api_2_0/throttling

### Description
Retrieves a list of predefined connection throttling configurations, including download speed, upload speed, and latency.

### Method
GET

### Endpoint
/websites/gtmetrix_api_2_0/throttling

### Parameters
None

### Request Example
```json
{
  "example": "GET /websites/gtmetrix_api_2_0/throttling"
}
```

### Response
#### Success Response (200)
- **throttling** (array) - A list of available connection throttling options.
  - **fullName** (string) - The full descriptive name of the connection profile.
  - **connectionStringId** (string) - The ID representing the connection string for this profile (e.g., '20000/5000/25').

#### Response Example
```json
{
  "example": {
    "throttling": [
      {
        "fullName": "Broadband Fast (20/5 Mbps, 25ms)",
        "connectionStringId": "20000/5000/25"
      },
      {
        "fullName": "LTE (15/10 Mbps, 100ms)",
        "connectionStringId": "15000/10000/100"
      }
    ]
  }
}
```
```

--------------------------------

### GET /api/2.0/pages/{page_id}/latest-report

Source: https://gtmetrix.com/api/docs/2.0/index

Fetches the most recent report for a specific page. The response format is the same as the 'Get a report' endpoint.

```APIDOC
## GET /api/2.0/pages/{page_id}/latest-report

### Description
Fetches the most recent report for a specific page. The response format is the same as the 'Get a report' endpoint.

### Method
GET

### Endpoint
/api/2.0/pages/{page_id}/latest-report

#### Path Parameters
- **page_id** (string) - Required - The unique identifier of the page whose latest report is to be fetched.

### Response
#### Success Response (200)
- **data** (object) - The report resource.
  - **type** (string) - The type of the resource, always "report".
  - **id** (string) - The unique identifier for the report.
  - **attributes** (object) - Contains details about the report.
    - **url** (string) - The URL that was tested.
    - **page** (string) - The ID of the page this report belongs to.
    - **test** (string) - The ID of the test that generated this report.
    - **source** (string) - The source of the report (e.g., "api").
    - **created** (integer) - Timestamp when the report was created.
    - **expires** (integer) - Timestamp when the report expires.
    - **gtmetrix_grade** (string) - The GTmetrix grade (e.g., "A").
    - **performance_score** (integer) - The performance score.
    - **structure_score** (integer) - The structure score.
  - **links** (object) - Links related to the report.
    - **har** (string) - URL to the HAR (HTTP Archive) resource.

#### Response Example
```json
{
  "data": {
    "type": "report",
    "id":   "{report_id}",
    "attributes": {
      "url":               "https://gtmetrix.com",
      "page":              "{page_id}",
      "test":              "{test_id}",
      "source":            "api",
      "created":           1660868227,
      "expires":           1676420227,
      "gtmetrix_grade":    "A",
      "performance_score": 94,
      "structure_score":   99,
      "...":               "..."
    },
    "links": {
      "har": "/api/2.0/reports/{report_id}/resources/har",
      "...": "..."
    }
  }
}
```

#### Possible errors
HTTP status | Error code | Error message
---|---|---
404 | E40404 | Page not found
```

--------------------------------

### Retrieve GTmetrix Report Data (HTTP GET)

Source: https://gtmetrix.com/api/docs/2.0/index

This HTTP GET request demonstrates how to retrieve the detailed report data for a completed GTmetrix test. It requires the unique report ID obtained after a test has finished.

```http
GET /api/2.0/reports/{report_id}
```

--------------------------------

### Analysis Options

Source: https://gtmetrix.com/api/docs/2.0/index

This object defines the parameters for initiating a website analysis. It includes settings for ad blocking, browser choice, viewport dimensions, custom block lists, cookies, DNS overrides, HTTP authentication, location, report type, data retention, throttling, URL, user agent, and video recording.

```APIDOC
## POST /websites/gtmetrix_api_2_0/analysis-options

### Description
Initiates a website analysis with specified configuration options.

### Method
POST

### Endpoint
/websites/gtmetrix_api_2_0/analysis-options

### Parameters
#### Request Body
- **data** (object) - Required - The main object containing analysis configuration.
  - **id** (string) - Optional - Identifier for the analysis, typically a report ID if updating.
  - **type** (string) - Required - Must be 'analysis-options'.
  - **attributes** (object) - Required - Contains the specific analysis parameters.
    - **adblock** (integer) - Optional - Enable ad blocking (1 for enabled, 0 for disabled).
    - **browser** (string) - Optional - The ID of the browser to use for the analysis.
    - **browser_dppx** (string) - Optional - Device pixel ratio for the browser.
    - **browser_height** (string) - Optional - Viewport height for the browser.
    - **browser_width** (string) - Optional - Viewport width for the browser.
    - **block_url** (array of strings) - Optional - URLs to block during analysis.
    - **cookies** (array of strings) - Optional - Cookies to set for the analysis (e.g., 'name=value').
    - **dns** (array of strings) - Optional - DNS overrides (e.g., 'example.com:1.1.1.1').
    - **httpauth_password** (string) - Optional - Password for HTTP authentication.
    - **httpauth_username** (string) - Optional - Username for HTTP authentication.
    - **location** (string) - Optional - The ID of the location to perform the analysis from.
    - **report** (string) - Required - The type of report to generate (e.g., 'lighthouse').
    - **retention** (integer) - Optional - How long to retain the report data (in days).
    - **throttle** (string) - Optional - Network throttling settings (e.g., '9000/5000/125').
    - **url** (string) - Required - The URL of the website to analyze.
    - **user_agent** (string) - Optional - Custom user agent string.
    - **video** (integer) - Optional - Enable video recording (1 for enabled, 0 for disabled).

### Request Example
```json
{
  "data": {
    "type": "analysis-options",
    "attributes": {
      "adblock": 1,
      "browser": "{browser_id}",
      "browser_height": "896",
      "browser_width": "414",
      "location": "{location_id}",
      "report": "lighthouse",
      "url": "https://gtmetrix.com/"
    }
  }
}
```

### Response
#### Success Response (200)
- **data** (object) - Contains the analysis results or status.
- **meta** (object) - Metadata about the API response, including versions of tools used.
  - **versions** (object) - Contains version information for tools like Lighthouse and Chrome.
```

--------------------------------

### List Simulated Devices

Source: https://gtmetrix.com/api/docs/2.0/index

Retrieves a list of all available simulated devices that can be used for performance testing. This includes details like device category, manufacturer, and screen dimensions.

```APIDOC
## GET /api/2.0/browsers

### Description
Retrieves a list of all available simulated devices that can be used for performance testing. This includes details like device category, manufacturer, and screen dimensions.

### Method
GET

### Endpoint
/api/2.0/browsers

### Parameters
#### Query Parameters
None

### Request Example
```bash
curl -u YOUR_API_KEY: \
    https://gtmetrix.com/api/2.0/browsers
```

### Response
#### Success Response (200)
- **data** (array of objects) - A list of Simulated Devices. Each object contains:
  - **id** (string) - The unique identifier for the simulated device.
  - **type** (string) - The resource type, always "simulated_device".
  - **attributes** (object) - Contains detailed properties of the device:
    - **category** (string) - The category of the device ("phone" or "tablet").
    - **dppx** (number) - The device's pixel ratio (1-5).
    - **height** (integer) - The device's display height in pixels.
    - **manufacturer** (string) - The device's manufacturer.
    - **name** (string) - The device's name.
    - **user_agent** (string) - The browser user-agent string used for the analysis.
    - **width** (integer) - The device's display width in pixels.

#### Response Example
```json
{
  "data": [
    {
      "attributes": {
        "category": "phone",
        "dppx": 3,
        "height": 896,
        "manufacturer": "Apple",
        "name": "iPhone 11 Pro/11 Pro Max/12 Pro Max",
        "user_agent": "Mozilla/5.0 (iPhone; CPU iPhone OS 14_5 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.5 Mobile/15E148 Safari/604.1 GTmetrix",
        "width": 414
      },
      "id": "iphone_xs_max",
      "type": "simulated_device"
    }
  ]
}
```
```

--------------------------------

### GET /api/2.0/locations/{location_id}

Source: https://gtmetrix.com/api/docs/2.0/index

Retrieves details for a specific test location by its ID.

```APIDOC
## GET /api/2.0/locations/{location_id}

### Description
Retrieves details for a specific test location by its ID.

### Method
GET

### Endpoint
/api/2.0/locations/{location_id}

### Parameters
#### Path Parameters
- **location_id** (string) - Required - The location ID.

### Response
#### Success Response (200)
- **data** (object) - A Location object.

#### Response Example
```json
{
  "data": {
    "type": "location",
    "id":   "{location_id}",
    "attributes": {
      "name":     "Hong Kong, China",
      "region":   "Asia Pacific",
      "default":  false,
      "account_has_access": true,
      "browsers": [ "{browser_id}", ... ],
      "ips": [ "{ip_address}", ... ]
    }
  }
}
```
```

--------------------------------

### List of Simulated Devices

Source: https://gtmetrix.com/api/docs/2.0/index

Retrieves a list of all simulated devices available for testing. This parameter is available with GTmetrix PRO plans.

```APIDOC
## GET /websites/gtmetrix_api_2_0/devices

### Description
Retrieves a list of all simulated devices that can be used for website performance testing. This feature requires a GTmetrix PRO plan.

### Method
GET

### Endpoint
/websites/gtmetrix_api_2_0/devices

### Parameters
#### Query Parameters
- **type** (string) - Optional - Filter devices by type (e.g., 'phones', 'tablets').

### Request Example
```json
{
  "example": "GET /websites/gtmetrix_api_2_0/devices?type=phones"
}
```

### Response
#### Success Response (200)
- **devices** (array) - A list of available simulated devices.
  - **id** (string) - The unique identifier for the device.
  - **name** (string) - The full name of the device.
  - **resolution** (string) - The screen resolution and DPR of the device.

#### Response Example
```json
{
  "example": {
    "devices": [
      {
        "id": "iphone_xr",
        "name": "Apple iPhone XR",
        "resolution": "414x896 @ 2 DPR"
      },
      {
        "id": "nexus_4",
        "name": "Google Nexus 4",
        "resolution": "384x640 @ 2 DPR"
      }
    ]
  }
}
```
```
Tokens:
Raw