Runs PageSpeed analysis on the page at the specified URL, and returns PageSpeed scores, a list of suggestions to make that page faster, and other information.

Required Scalar Argument

  • <url> (string)
    • The URL to fetch and analyze

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

  • -o out
    • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional Method Properties

You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness.

  • -p filter-third-party-resources=boolean

    • Indicates if third party resources should be filtered out before PageSpeed analysis.

  • -p locale=string

    • The locale used to localize formatted results

  • -p rule=string

    • A PageSpeed rule to run; if none are given, all rules are run

  • -p screenshot=boolean

    • Indicates if binary data containing a screenshot should be included

  • -p snapshots=boolean

    • Indicates if binary data containing snapshot images should be included

  • -p strategy=string

    • The analysis strategy (desktop or mobile) to use, and desktop is the default

  • -p utm-campaign=string

    • Campaign name for analytics.

  • -p utm-source=string

    • Campaign source for analytics.

Optional General Properties

The following properties can configure any call, and are not specific to this method.

  • -p alt=string

    • Data format for the response.

  • -p fields=string

    • Selector specifying which fields to include in a partial response.

  • -p key=string

    • API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

  • -p oauth-token=string

    • OAuth 2.0 token for the current user.

  • -p pretty-print=boolean

    • Returns response with indentations and line breaks.

  • -p quota-user=string

    • An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • -p user-ip=string

    • Deprecated. Please use quotaUser instead.