PageSpeed

Run a PageSpeed audit

Changed on

Measures pages with Google PageSpeed Insights and stores the results. SPENDS the team's PageSpeed quota - confirm with the user before running, especially with allPages, which audits the entire site. Runs in the background; poll the page-speed list for status. Omit both url and targets with allPages=true to re-audit everything.

post/v3/page-speed/run

Request

  • Base URL: https://api.snowseo.com
  • URL: https://api.snowseo.com/v3/page-speed/run
  • Auth: one of:
    • HTTP bearer
    • API key in header x-api-key

Request body

teamIdstring

SnowSEO team ID. Call list_teams first to choose a team.

auditIdstring required

SEO audit ID for this team's site.

action'test-pages'
previewboolean
urlstring

Single page URL to audit. Ignored when allPages is true.

strategiesstring[]

Devices to test. Defaults to both.

allPagesboolean

Audit every page of the site. Expensive — this can consume a large share of the team's PageSpeed quota.

forceboolean

Re-audit even if the stored result is still fresh.

Response

Default Response

unitsnumber
statusstring
messagestring
urlstring
fetchedAtstring nullable
mobileErrorstring nullable
desktopErrorstring nullable

Changes

  • 2f74a3484a65Revision changes
    • info

      added the new optional request property ///

    • info

      added the new optional request property ///

  • 7ede4ba45814Revision changes
    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status