v

latestOpenAPI 3.0.02026-08-084780295.1 KB

Website Audit

Generate a website audit PDF report

Generates a PDF for a page or overview audit and either downloads it, uploads it to R2 (share link), or emails it as an attachment.

post/v3/website-audit/pdf/

action'download' | 'share' | 'email' required

What to do with the generated PDF: stream as download, upload to R2 and return a share URL, or email it to email.

type'page' | 'overview' | 'page-speed-page' | 'page-speed-overview'

Which PDF document to render: website-audit page or overview, or PageSpeed page or overview.

dataobject required

Payload — shape depends on type. Must include pageUrl (use the base URL for overview variants).

emailstring email

Recipient address. Required when action is email.

teamIdstring

Team that owns the audit. Membership is enforced by checkMembership.

whiteLabelboolean

Apply the org's white-label brand mark (when enabled and plan-gated). Pass false to force the SnowSEO mark for this export.