View as Markdown
GTmetrix icon

GTmetrix ACTION

Run Performance Test

Run a performance test on a specified URL using GTmetrix. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's GTmetrix account once, then configure and run Run Performance Test from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "gtmetrix-run-performance-test",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    gtmetrix: { authProvisionId: "apn_xxxxxxx" },
    url: "URL",
    locationId: "Location",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Run Performance Test inputs
Property Type Description
url URL string
The URL of the page to test
Required
locationId Location string
Identifier of a location. Visit the Locations Page for more information on Basic and Premium test locations.
Optional Dynamic
browserId Browser string
Identifier of a browser
Optional Dynamic
waitForReport Wait for Report boolean
Set to true to poll the API in 3-second intervals until the test is completed. Will return the report.
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
gtmetrix-run-performance-test
Version
0.0.2
App
GTmetrix
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes