v6

OpenAPI 3.0.02026-08-044760291.8 KB

Website Audit

Queue a website audit PDF export

Stores the export payload, enqueues a render job and returns a job id to poll. Use this instead of POST /website-audit/pdf for large reports, which cannot finish inside the edge timeout.

post/v3/website-audit/pdf/jobs

Request body

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

What to do with the rendered PDF. download and share return a URL from the status endpoint; email sends it as an attachment.

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

Which document to render.

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 entitled.

Response

Default Response

jobIdstring

statusstring