pagespeedonline/v5 library

PageSpeed Insights API - v5

The PageSpeed Insights API lets you analyze the performance of your website with a simple API. It offers tailored suggestions for how you can optimize your site, and lets you easily integrate PageSpeed Insights analysis into your development tools and workflow.

For more information, see developers.google.com/speed/docs/insights/v5/about

Create an instance of PagespeedInsightsApi to access these resources:

Classes

AuditRefs
A light reference to an audit by id, used to group and weight audits in a given category.
Bucket
A proportion of data in the total distribution, bucketed by a min/max percentage.
Categories
The categories in a Lighthouse run.
CategoryGroupV5
Message containing a category
ConfigSettings
Message containing the configuration settings for the Lighthouse run.
Environment
Message containing environment configuration for a Lighthouse run.
I18n
Message containing the i18n data for the LHR - Version 1.
LhrEntity
Message containing an Entity.
LighthouseAuditResultV5
An audit's result object in a Lighthouse result.
LighthouseCategoryV5
A Lighthouse category.
LighthouseResultV5
The Lighthouse result object.
PagespeedApiLoadingExperienceV5
The CrUX loading experience object that contains CrUX data breakdowns.
PagespeedApiPagespeedResponseV5
The Pagespeed API response object.
PagespeedapiResource
PagespeedInsightsApi
The PageSpeed Insights API lets you analyze the performance of your website with a simple API.
PagespeedVersion
The Pagespeed Version object.
RendererFormattedStrings
Message holding the formatted strings used in the renderer.
RuntimeError
Message containing a runtime error config.
StackPack
Message containing Stack Pack information.
Timing
Message containing the performance timing data for the Lighthouse run.
UserPageLoadMetricV5
A CrUX metric object for a single metric and form factor.

Exceptions / Errors

ApiRequestError
Represents a general error reported by the API endpoint.
DetailedApiRequestError
Represents a specific error reported by the API endpoint.