latestOpenAPI 3.0.02026-08-215090368.2 KB

c8f1f876a92c

PageSpeed

Run a PageSpeed audit

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 returned job. Omit both url and targets with allPages=true to re-audit everything.

post/v3/page-speed/run

Request body

teamIdstring

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

auditIdstring required

SEO audit ID for this team's site.

urlstring

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

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