Close httplib2 connections.
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.
close()
Close httplib2 connections.
runpagespeed(locale=None, strategy=None, utm_source=None, category=None, captchaToken=None, url=None, utm_campaign=None, x__xgafv=None)
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.
Args:
locale: string, The locale used to localize formatted results
strategy: string, The analysis strategy (desktop or mobile) to use, and desktop is the default
Allowed values
STRATEGY_UNSPECIFIED - UNDEFINED.
DESKTOP - Fetch and analyze the URL for desktop browsers.
MOBILE - Fetch and analyze the URL for mobile devices.
utm_source: string, Campaign source for analytics.
category: string, A Lighthouse category to run; if none are given, only Performance category will be run (repeated)
Allowed values
CATEGORY_UNSPECIFIED - Default UNDEFINED category.
ACCESSIBILITY - Accessibility (a11y), category pertaining to a website's capacity to be accessible to all users.
BEST_PRACTICES - Best Practices, category pertaining to a website's conformance to web best practice.
PERFORMANCE - Performance, category pertaining to a website's performance.
PWA - Progressive Web App (PWA), category pertaining to a website's ability to be run as a PWA.
SEO - Search Engine Optimization (SEO), category pertaining to a website's ability to be indexed by search engines.
captchaToken: string, The captcha token passed when filling out a captcha.
url: string, Required. The URL to fetch and analyze
utm_campaign: string, Campaign name for analytics.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The Pagespeed API response object.
"originLoadingExperience": { # The CrUX loading experience object that contains CrUX data breakdowns. # Metrics of the aggregated page loading experience of the origin
"overall_category": "A String", # The human readable speed "category" of the id.
"id": "A String", # The url, pattern or origin which the metrics are on.
"origin_fallback": True or False, # True if the result is an origin fallback from a page, false otherwise.
"metrics": { # The map of .
"a_key": { # A CrUX metric object for a single metric and form factor.
"formFactor": "A String", # Identifies the form factor of the metric being collected.
"metricId": "A String", # Identifies the type of the metric.
"percentile": 42, # We use this field to store certain percentile value for this metric. For v4, this field contains pc50. For v5, this field contains pc90.
"category": "A String", # The category of the specific time metric.
"median": 42, # The median number of the metric, in millisecond.
"distributions": [ # Metric distributions. Proportions should sum up to 1.
{ # A proportion of data in the total distribution, bucketed by a min/max percentage. Each bucket's range is bounded by min <= x < max, In millisecond.
"proportion": 3.14, # The proportion of data in this bucket.
"min": 42, # Lower bound for a bucket's range.
"max": 42, # Upper bound for a bucket's range.
},
],
},
},
"initial_url": "A String", # The requested URL, which may differ from the resolved "id".
},
"captchaResult": "A String", # The captcha verify result
"lighthouseResult": { # The Lighthouse result object. # Lighthouse response for the audit url as an object.
"categories": { # The categories in a Lighthouse run. # Map of categories in the LHR.
"seo": { # A Lighthouse category. # The Search-Engine-Optimization (SEO) category, containing all seo related audits.
"id": "A String", # The string identifier of the category.
"description": "A String", # A more detailed description of the category and its importance.
"title": "A String", # The human-friendly name of the category.
"score": "", # The overall score of the category, the weighted average of all its audits. (The category's score, can be null.)
"manualDescription": "A String", # A description for the manual audits in the category.
"auditRefs": [ # An array of references to all the audit members of this category.
{ # A light reference to an audit by id, used to group and weight audits in a given category.
"group": "A String", # The category group that the audit belongs to (optional).
"id": "A String", # The audit ref id.
"weight": 3.14, # The weight this audit's score has on the overall category score.
},
],
},
"accessibility": { # A Lighthouse category. # The accessibility category, containing all accessibility related audits.
"id": "A String", # The string identifier of the category.
"description": "A String", # A more detailed description of the category and its importance.
"title": "A String", # The human-friendly name of the category.
"score": "", # The overall score of the category, the weighted average of all its audits. (The category's score, can be null.)
"manualDescription": "A String", # A description for the manual audits in the category.
"auditRefs": [ # An array of references to all the audit members of this category.
{ # A light reference to an audit by id, used to group and weight audits in a given category.
"group": "A String", # The category group that the audit belongs to (optional).
"id": "A String", # The audit ref id.
"weight": 3.14, # The weight this audit's score has on the overall category score.
},
],
},
"performance": { # A Lighthouse category. # The performance category, containing all performance related audits.
"id": "A String", # The string identifier of the category.
"description": "A String", # A more detailed description of the category and its importance.
"title": "A String", # The human-friendly name of the category.
"score": "", # The overall score of the category, the weighted average of all its audits. (The category's score, can be null.)
"manualDescription": "A String", # A description for the manual audits in the category.
"auditRefs": [ # An array of references to all the audit members of this category.
{ # A light reference to an audit by id, used to group and weight audits in a given category.
"group": "A String", # The category group that the audit belongs to (optional).
"id": "A String", # The audit ref id.
"weight": 3.14, # The weight this audit's score has on the overall category score.
},
],
},
"best-practices": { # A Lighthouse category. # The best practices category, containing all best practices related audits.
"id": "A String", # The string identifier of the category.
"description": "A String", # A more detailed description of the category and its importance.
"title": "A String", # The human-friendly name of the category.
"score": "", # The overall score of the category, the weighted average of all its audits. (The category's score, can be null.)
"manualDescription": "A String", # A description for the manual audits in the category.
"auditRefs": [ # An array of references to all the audit members of this category.
{ # A light reference to an audit by id, used to group and weight audits in a given category.
"group": "A String", # The category group that the audit belongs to (optional).
"id": "A String", # The audit ref id.
"weight": 3.14, # The weight this audit's score has on the overall category score.
},
],
},
"pwa": { # A Lighthouse category. # The Progressive-Web-App (PWA) category, containing all pwa related audits.
"id": "A String", # The string identifier of the category.
"description": "A String", # A more detailed description of the category and its importance.
"title": "A String", # The human-friendly name of the category.
"score": "", # The overall score of the category, the weighted average of all its audits. (The category's score, can be null.)
"manualDescription": "A String", # A description for the manual audits in the category.
"auditRefs": [ # An array of references to all the audit members of this category.
{ # A light reference to an audit by id, used to group and weight audits in a given category.
"group": "A String", # The category group that the audit belongs to (optional).
"id": "A String", # The audit ref id.
"weight": 3.14, # The weight this audit's score has on the overall category score.
},
],
},
},
"finalUrl": "A String", # The final resolved url that was audited.
"requestedUrl": "A String", # The original requested url.
"runtimeError": { # Message containing a runtime error config. # A top-level error message that, if present, indicates a serious enough problem that this Lighthouse result may need to be discarded.
"message": "A String", # A human readable message explaining the error code.
"code": "A String", # The enumerated Lighthouse Error code.
},
"categoryGroups": { # Map of category groups in the LHR.
"a_key": { # Message containing a category
"title": "A String", # The human readable title of the group
"description": "A String", # The description of what the category is grouping
},
},
"audits": { # Map of audits in the LHR.
"a_key": { # An audit's result object in a Lighthouse result.
"score": "", # The score of the audit, can be null.
"errorMessage": "A String", # An error message from a thrown error inside the audit.
"title": "A String", # The human readable title.
"numericValue": 3.14, # A numeric value that has a meaning specific to the audit, e.g. the number of nodes in the DOM or the timestamp of a specific load event. More information can be found in the audit details, if present.
"explanation": "A String", # An explanation of the errors in the audit.
"displayValue": "A String", # The value that should be displayed on the UI for this audit.
"warnings": "", # Possible warnings that occurred in the audit, can be null.
"scoreDisplayMode": "A String", # The enumerated score display mode.
"details": { # Freeform details section of the audit.
"a_key": "", # Properties of the object.
},
"id": "A String", # The audit's id.
"description": "A String", # The description of the audit.
},
},
"environment": { # Message containing environment configuration for a Lighthouse run. # Environment settings that were used when making this LHR.
"hostUserAgent": "A String", # The user agent string of the version of Chrome used.
"networkUserAgent": "A String", # The user agent string that was sent over the network.
"benchmarkIndex": 3.14, # The benchmark index number that indicates rough device class.
},
"fetchTime": "A String", # The time that this run was fetched.
"configSettings": { # Message containing the configuration settings for the Lighthouse run. # The configuration settings for this LHR.
"locale": "A String", # The locale setting.
"onlyCategories": "", # List of categories of audits the run should conduct.
"emulatedFormFactor": "A String", # The form factor the emulation should use.
"channel": "A String", # How Lighthouse was run, e.g. from the Chrome extension or from the npm module.
},
"userAgent": "A String", # The user agent that was used to run this LHR.
"i18n": { # Message containing the i18n data for the LHR - Version 1. # The internationalization strings that are required to render the LHR.
"rendererFormattedStrings": { # Message holding the formatted strings used in the renderer. # Internationalized strings that are formatted to the locale in configSettings.
"opportunitySavingsColumnLabel": "A String", # The heading for the estimated page load savings of opportunity audits.
"varianceDisclaimer": "A String", # The disclaimer shown below a performance metric value.
"scorescaleLabel": "A String", # The label that explains the score gauges scale (0-49, 50-89, 90-100).
"toplevelWarningsMessage": "A String", # The label shown preceding important warnings that may have invalidated an entire report.
"passedAuditsGroupTitle": "A String", # The heading that is shown above a list of audits that are passing.
"lsPerformanceCategoryDescription": "A String", # The disclaimer shown under performance explaning that the network can vary.
"warningHeader": "A String", # The label shown above a bulleted list of warnings.
"auditGroupExpandTooltip": "A String", # The tooltip text on an expandable chevron icon.
"notApplicableAuditsGroupTitle": "A String", # The heading shown above a list of audits that do not apply to a page.
"errorLabel": "A String", # The label shown next to an audit or metric that has had an error.
"labDataTitle": "A String", # The title of the lab data performance category.
"manualAuditsGroupTitle": "A String", # The heading shown above a list of audits that were not computerd in the run.
"opportunityResourceColumnLabel": "A String", # The heading for the estimated page load savings opportunity of an audit.
"crcLongestDurationLabel": "A String", # The label for values shown in the summary of critical request chains.
"errorMissingAuditInfo": "A String", # The error string shown next to an erroring audit.
"crcInitialNavigation": "A String", # The label for the initial request in a critical request chain.
},
},
"stackPacks": [ # The Stack Pack advice strings.
{ # Message containing Stack Pack information.
"title": "A String", # The stack pack title.
"descriptions": { # The stack pack advice strings.
"a_key": "A String",
},
"iconDataURL": "A String", # The stack pack icon data uri.
"id": "A String", # The stack pack id.
},
],
"runWarnings": [ # List of all run warnings in the LHR. Will always output to at least `[]`.
"",
],
"lighthouseVersion": "A String", # The lighthouse version that was used to generate this LHR.
"timing": { # Message containing the performance timing data for the Lighthouse run. # Timing information for this LHR.
"total": 3.14, # The total duration of Lighthouse's run.
},
},
"version": { # The Pagespeed Version object. # The version of PageSpeed used to generate these results.
"major": "A String", # The major version number of PageSpeed used to generate these results.
"minor": "A String", # The minor version number of PageSpeed used to generate these results.
},
"kind": "A String", # Kind of result.
"id": "A String", # Canonicalized and final URL for the document, after following page redirects (if any).
"loadingExperience": { # The CrUX loading experience object that contains CrUX data breakdowns. # Metrics of end users' page loading experience.
"overall_category": "A String", # The human readable speed "category" of the id.
"id": "A String", # The url, pattern or origin which the metrics are on.
"origin_fallback": True or False, # True if the result is an origin fallback from a page, false otherwise.
"metrics": { # The map of .
"a_key": { # A CrUX metric object for a single metric and form factor.
"formFactor": "A String", # Identifies the form factor of the metric being collected.
"metricId": "A String", # Identifies the type of the metric.
"percentile": 42, # We use this field to store certain percentile value for this metric. For v4, this field contains pc50. For v5, this field contains pc90.
"category": "A String", # The category of the specific time metric.
"median": 42, # The median number of the metric, in millisecond.
"distributions": [ # Metric distributions. Proportions should sum up to 1.
{ # A proportion of data in the total distribution, bucketed by a min/max percentage. Each bucket's range is bounded by min <= x < max, In millisecond.
"proportion": 3.14, # The proportion of data in this bucket.
"min": 42, # Lower bound for a bucket's range.
"max": 42, # Upper bound for a bucket's range.
},
],
},
},
"initial_url": "A String", # The requested URL, which may differ from the resolved "id".
},
"analysisUTCTimestamp": "A String", # The UTC timestamp of this analysis.
}