Documentation

# Overview

PageSpeed Plus is a tool for monitoring Google PageSpeed Insights scores on a website and running scans in bulk across the entire website.

This is is not an official Google product. It is an external service built around V5 of the PageSpeed API, which is powered by Lighthouse

PageSpeedPlus requires a PageSpeed API key to make requests on your behalf.

Requirements

  • A PageSpeed API Key. Can be created here.
  • The URL of your sitemap.xml file. It must be valid XML.

# Account Setup

Setting up your PageSpeed Plus account is quick and easy by following a few simple steps.

Create Account

Before getting started with PageSpeed Plus you need to create an account. Click here to open the registration page. All accounts come with a 30 day completely free trial.

Logging In

If you already have an account you can log in to the PageSpeed Plus backend by clicking Login on the homepage or clicking here.

Once your account is created, it needs to be linked to Google so we can query your pages with the PageSpeed API.

API Keys can be created and viewed in the Google API dashboard.

Steps:

  • Click here to open the PageSpeed Insights docs.
  • Click > Get A Key
  • Go to the settings page of your PageSpeed Plus account
  • Paste Your API Key
  • Click Update

API Key Security

By default, API Keys are created without any restrictions. If you would like to limit how your API Key can be used, it can be done from the credentials sections of your Google API's portal.

  • IP Address
  • Select IP address and enter the IP for PageSpeedPlus. (This is available upon request if you create a support ticket.)

    # Add Site

    • Go to the dashboard and click Add Site
    • Give it a name
    • Enter the homepage URL
    • Enter the path the to the sitemap.xml file
    • Click Start

    Every page listed in your sitemap.xml file will now be measured with the PageSpeed Insights API. The more pages your site has the longer it lasts but we can do multiple URLs in parallel to accelerate the process. You can see the progress and view pages as they complete.

    Once a scan finishes you will receive an email and can view the full contents of the report from your dashboard.

    # Full Site Scan

    When a site is added for the first time, an initial full site scan starts so we can get an overview of your score. Average scores are available for every report. These can be viewed in the analytics section.


    Automated

    After the initial site setup, a full site scan runs once per week. You will receive an email with the results each time and the full report can accessed from the site details page.

    On Demand (Pro plans only)

    You can also run full site scans on demand by clicking the Scan Full Site button from the site details page

    # Monitored URLs

    PageSpeedPlus can scan your important URLs quickly on a daily basis and notify you if they are slow.

    Add URLs
    • To have a URL monitored, add it to the monitored URLs section
    • Set the alert threshold. If a page falls below this on mobile or desktop you will receive a notification.
    • Set how often you want the URL to be checked

    Automated

    The URLs will now be scanned at the frequency you specified and you will receive an email if they are slow.

    On Demand (Pro plans only)

    You can also run monitored URLs scans on demand by clicking the Scan Monitored URLs button from the site details page

    Slack Notifications

    You can also receive notifications via slack.

    • First create a slack web hook URL
    • Go to the settings page in your account
    • Enter a slack web hook URL you want us to notify

    # Excluding From Analytics

    The PageSpeed Insights API executes javascript when testing URLs so every time a page is scanned on your site, it will be treated as a real visitor and log a hit in your analytics. You may want to exclude this traffic from your analytics to prevent your data being skewed.

    There are two ways this can be done:

    • URL Parameter
    • A parameter can be added to URLs every time a request is made by PageSpeedPlus. In the the Full Site Scans section, enter the desired parameter without a ? symbol. For example: referrer=pagespeedplus

      You would then exclude traffic with this parameter in Google Analytics.

    • IP Address
    • You can ignore our IP address from your Google Analytics. (This is available upon request if you create a support ticket.)

        # Troubleshooting

        If a PageSpeed API key is created correctly, your scans should start working immediately. If your scans are not working, here are some steps to troubleshoot:

        Scans not working

        Check if your API key is working from the PageSpeed Plus settings page

        Scans stuck in queued state

        Users on trial or basic plans have shared queues with other users. You can wait in line or upgrade to get access to a personal queue.

        Scores not returned for some pages

        If the score is close to 0, the PageSpeed API will return nothing

        Scans stopping half way through

        Google sets a limit of 25,000 API requests per day per project. Each page you scan uses two credits - one for mobile and one for desktop. If you have more than 12,500 pages to scan, you will need to create another project in the Google PageSpeed dashboard and generate a second API key to use for a portion of your sites. Consider a setup like this with one key in each project:


        If you still have questions, contact us from the support section of your dashboard.

        # API

        PageSpeed Plus offers an API so you can integrate data from your account into other tools and dashboards.

        Routes

        /api/monitored-urls

        get all monitored URLs


        /api/sites

        get all sites


        /api/site/{id}

        get a single site by ID


        /api/site/{id}/reports

        get all reports


        /api/site/{id}/report/{report_id}

        get a single report by site ID and report ID


        Create Key

        You will need to create an API key on your settings page to access your scan data.

        • Create an PageSpeed Plus API key in your settings area

        Making A Request

        This api_key must be added as a parameter on all requests to the API.

        https://app.pagespeedplus.com/api/site/6?api_token=YOUR_KEY

        Replace YOUR_KEY with the generated API key

        Example
        https://app.pagespeedplus.com/api/site/6?api_token=738fg98jhfg7s61sg4j7s9fg6