Insights from Google PageSpeed v2.x Documentation by Matt Keys

Insights from Google PageSpeed


Insights from Google PageSpeed

Created: 09/28/2013
Updated: 03/18/2017
By: Matt Keys
mattkeys.me

Thank you for downloading Insights from Google PageSpeed. If you have any questions that are beyond the scope of this help file, please visit mattkeys.me. Thanks so much!

Table of Contents

  1. Overview
  2. Installation
  3. Required Configuration (Google API Key)
  4. Recommended Configuration
  5. Report List
  6. Report Summary
  7. Snapshots
  8. Custom URLs
  9. Ignored URLs
  10. Troubleshooting

A) Overview - top

Google Pagespeed Insights is a tool that empowers you to make decisions that increase the performance of your website by expanding on the existing technology of Google Pagespeeds recommendations for current industry best practices for desktop and mobile web performance.

Through the addition of advanced data visualization, tagging, filtering, and snapshot technology, Insights from Google PageSpeed provides a comprehensive solution for any webmaster looking to increase their site performance, search engine ranking, and visitors browsing experience.

B) Installation - top

To install Insights from Google PageSpeed:

  1. Login to your Wordpress Admin page (usually http://yourdomain.com/wp-admin)
  2. Navigate to the Plugins screen and then click the "Add New" button
  3. Click on the "Upload" link near the top of the page and browse for the Insights from Google PageSpeed zip file
  4. Upload the file, and click "Activate Plugin" after the installation completes
  5. Congratulations, installation is complete!

C) Required Configuration - top

Required - Obtain and Enter a Google API Key:

Google API Key's are free, and can be obtained from Google. In order to get a key, you will need a Google account such as a GMail account. If you do not already have a Google account you can create one here: https://accounts.google.com/SignUp.

Google often changes the layout and process involved in enabling their APIs and obtaining an API Key, but the general process stays the same.

  1. Login to Google API Console
  2. Create a new project
  3. Enable the PageSpeed Insights API
  4. Create an API Key
  5. Paste the API Key into the Insights from Google PageSpeed options page

Below I will provide a more in depth step by step guide based on the current version Google API Console; but know that depending on when you are reading this guide, things may not look the way they do in my screenshots anymore, and in priciple you should be looking to follow the 5 basic steps outlined above.

  1. Navigate to https://console.developers.google.com. If you are not already logged into your google account, log in now.

  2. Once logged in you should create a project. Name the project anything you'd like, such as: PageSpeed Insights. Agree to the terms and service if asked. It may take 10-20 seconds for the new project to be created, be patient. If you have already created a project previously that you want to use, select that project and skip ahead to enabling the PageSpeed Insights API.

  3. After your project has been created, you can enable the google services you want to use from the API Library. Find / Search for "PageSpeed Insights API", and click it.

  4. Enable the PageSpeed Insights API

  5. Create credentials for using the PageSpeed API from the credentials page. The type of credentials that we want to make are "API Key".

  6. Google will generate an API Key for you to use, copy it to your clipboard, we will need it later. You can come back to the credentials page if you misplace it.

  7. Google will give you the option the restrict usage of your API Key. Be careful that you do not accidently add a restriction that will block your site form using this key. This is one of the most common causes for scans not running properly when people ask for support. I recommend that you first try the plugin without any restrictions to make sure that it is working as expected, and then consider adding restrictions if desired.

  8. Paste your API key into the Insights from Google PageSpeed plugin, and Save.


Recommended Configuration

The following items are not required, but it is recommended that you review them to match their options to your preferences

Google Pagespeed Options:

  1. Google Response Language: Select which language you would like to receive Pagespeed recommendations in.
  2. Report Type(s): Which types of recommendations do you want to receive? (Mobile, Desktop, or Both)

Scheduling and URL Configuration:

  1. Automatically re-check Pagespeed Insights scores using a schedule: Schedule the Insights from Google PageSpeed plugin to automatically find new pages, and recheck existing pages.
  2. Recheck Schedule: Recheck Schedule can be set to Daily, Weekly, Bi-Monthly, and Monthly.
  3. Configure which types of URLs to check: Choices include: Pages, Posts, Category Indexes, Custom URLs, Custom Post Types
Note: It takes a number of seconds for Google to check each page. Checking 500 pages may take approximately 30+ minutes for example. Keep this in mind when choosing which types of pages you wish to include in your reports. Some Custom Post Types generate MANY posts and should probably be avoided. Such as the bbPress Reply Custom Post Type.

E) Report List - top


Report List

Once you have configured the options, Insights from Google PageSpeed will start generating reports for your pages. Click on the "Report List" tab to view a list of all page reports.

If you do not see any reports listed, wait a bit and refresh the page. If problems persist, please see the troubleshooting section.

Page Reports can be sorted by type as well as score. The reports can also be filtered to show only reports from a particular type of URL. Click into any page report to see a detailed Pagespeed Report showing your biggest areas for improvement.

F) Report Summary - top


Report Summary

The Report Summary tab shows a unique view of your sites Google Pagespeed performance. From this tab you will find averages for all of your performance data, including your largest areas of opportunity from accross your site. The Report Summary page can be filtered to show summaries of any particular Report type.

If you have Mobile and Desktop reporting on, use the 'Mobile Mode' and 'Desktop Mode' buttons in the top right of the screen to toggle between the two reports.

G) Snapshots - top


Snapshots

The Report Snapshot tool builds on the power of Report Summaries, to provide historical “Point In Time” data about your website.

Take a snapshot of any Report Summary screen to store that data for future retrieval. Add comments to your snapshots to provide additional meaning, such as “Before Installing W3 Total Cache.” Additionally, filter a Report Summary before taking a Snapshot to save a summary of the filtered data.

To Take a Snapshot:

  1. Navigate to the "Report Summary" Tab.
  2. (Optional) Filter the Report Summary Page if you would like to take a Snapshot for a particular report type.
  3. If you have Mobile and Desktop reporting on, use the 'Mobile Mode' and 'Desktop Mode' buttons in the top right of the screen to select the report type you wish to Snapshot
  4. (Optional) Add a comment to the textbox just left of the "Save Report Snapshot" button. This comment will be viewable later to help identify your snapshots.
  5. Click "Save Report Snapshot"

To View a Snapshot:

  1. Navigate to the "Snapshots" Tab.
  2. From the list of available Snapshots, click on the one you wish to view.

To Compare a Snapshot:

A Snapshot can be compared side by side with any other Snapshot of the same type. For instance you can compare a Desktop snapshot of the "All Reports" type, with another Desktop Snapshot of the "All Reports" type. Use the Snapshot comparison tool to measure the effect of changes in plugins, or your code.

  1. Navigate to the "Snapshots" Tab.
  2. From the list of available Snapshots, click on the first Snapshot that you would like to compare against.
  3. If there are any similiar snapshots available, they will appear in the top right dropdown menu. Otherwise it will state "No SImiliar Snapshots Found". Select your snapshot and click "Compare".

H) Custom URLs - top


Custom URLs

Easily add additional URLs for inclusion in Pagespeed Reports. Even add URLs for non-Wordpress sites, even if they are not hosted on your server. URLs can be added manually, or upload a properly formatted XML sitemap to add multiple pages at once.

Custom URLs can be tagged and filtered in Report Summaries. Take Report Snapshots of your Custom URLs just like you would with any other report type.

To Add Custom URLs manually:

  1. Navigate to the "Custom URLs" tab
  2. Click the "Add New URLs" button from the top.
  3. Give your custom URLs as label. If you are adding URLs from you sister-companies website, you might label the custom URLs "Sister Company". Using a descriptive Label is important because it will be used throughout the site when filtering your reports and creating Snapshots.
  4. Enter up to 10 custom URLs in the provided fields and click "Submit" when you are done.

To Add Custom URLs in Bulk:

  1. Navigate to the "Custom URLs" tab
  2. Click the "Bulk Upload New URLs" button from the top.
  3. Give your custom URLs as label. If you are adding URLs from you sister-companies website, you might label the custom URLs "Sister Company". Using a descriptive Label is important because it will be used throughout the site when filtering your reports and creating Snapshots.
  4. Upload a properly formatted XML file containing the URLs that you wish to add. XML Sitemaps like this can be created by many Wordpress plugins and web services. http://www.xml-sitemaps.com/ is one such web service.

I) Ignored URLs - top


Ignored URLs

Sometimes reports may appear in your Report List or Report Summary that you do not wish to include in your results. For these pages the "Ignored URLs" section exists.

To Ignore a URL:

  1. Find the URL that you wish to ignore from the Report List tab.
  2. Either hover over the URL and click "Ignore"; Or if you have many pages to ignore, you can check the box for each URL to ignore and then select "Ignore" from the bulk actions dropdown.
  3. Ignored pages will no longer appear in your reports, and they will be skipped on future report scans.

To Reactivate an Ignored URL:

  1. Find the URL that you wish to reactivate from the Ignored URLs tab.
  2. Either hover over the URL and click "Reactive"; Or if you have many pages to reactivate, you can check the box for each URL and then select "Reactivate" from the bulk actions dropdown.
  3. Pages will be rescanned the next time Google Pagespeed checks your sites pages. Afterwords the pages will start showing up in your reports again.

J) Troubleshooting - top

Please find the below list of potential issues that you may encounter, and the recommended next steps.

I entered my API Key and saved the Options, but no Reports are showing up in the Report List.

  1. Google Pagespeed needs to be able to load each page to create its report. Make sure that your pages are publicly accessible over the internet.
  2. Ensure that your API key is entered correctly, and that you have enabled the "PageSpeed Insights API" from the Google API Console.
  3. In the Options page, under "Advanced Configuration" there is a checkbox called "Log API Exceptions". Any API exception that is not caught and handled automatically will be stored for up to 7 days. This log information can be very helpful when diagnosing issues.

Page report checks never finish all of the way, I have to press "Save Options & Check Pages" again and again to get it to finish checking all of my pages.

  1. If the reports seem to always run for a certain length of time before stopping unexpectedly, you may be exceeding your servers Max Execution time. Try increasing the value in Options->Advanced Configuration "Maximum Execution Time".
  2. Some web hosting providers do not allow the Maximum Execution Time to be overridden or increased. In that case you can try setting the Maximum Script Run Time. This will make the script run for the set period of time, then stop and spawn a new script, to get around timeout issues. Start with a low value, and test. Increase the value one step at a time until you find the largest value that allows your scans to finish successfully.

An error was reported while trying to check on of my pages, and it has been added to the Ignored Pages section.

  1. Navigate to the Ignored Pages tab, find the page, and click "reactivate" to try it again.
  2. If the page fails again, ensure that the page is publicly accessible from the internet. Non-public pages cannot be checked.
  3. In some rare cases, pages are not able to be scanned by the Pagespeed API. Try checking your page manually here: https://developers.google.com/speed/pagespeed/insights/. If the page fails to be checked, report the issue to Google so that they can diagnose further.

I received a Javascript or PHP error.

  1. If the error appeared while Google Pagespeed was checking pages, you may have loaded the page while it was storing data. Refresh the page in a couple seconds to see if the issue has gone away.
  2. If issues persist please report the problem with as much information as you can gather, including: What page you were on, the exact text of the error, or a screenshot of the error.
  3. In the Options page, under "Advanced Configuration" there is a checkbox called "Log API Exceptions". Any API exception that is not caught and handled automatically will be logged for up to 7 days. This log information can be very helpful when diagnosing issues

My Page Scores seem really low. When I click "Recheck Results" when viewing Report Details, the score jumps up dramatically.

  1. Your server may have been responding slowly when the first report was generated. A slow server response time can have a large impact on your Page Speed Score. If these problems happen frequently you may want to talk with your hosting provider about the problem, or look into alternative hosting providers.

I want to clear out all of the current page reports and start over.

  1. Navigate to the "Options" tab
  2. Expand the "Advanced Configuration" section.
  3. Find the "Delete Data" Dropdown
  4. Select "Delete Reports Only" to remove all Page Reports
  5. Or Select "Delete EVERYTHING" to remove all Page Reports, Custom URLs, Snapshots, and Ignored Pages

Enjoy your plugin and thank you for downloading!

Go To Table of Contents