Sign in
PDF Export

Queue a PDF export

Stores the export payload, enqueues a render job and returns a job id to poll. Renders SEO-audit and PageSpeed reports alike - type selects the document. Async because a large render exceeds the 100s edge timeout.

post/v3/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' | 'geo' | 'combined'

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

Changes

Changed in 2 of the 47 revisions of this API.3

  • c44f51a92d952See the full diff
    • ○

      added the new combined enum value to the request property

      request-property-enum-value-added

    • ○

      added the new geo enum value to the request property

      request-property-enum-value-added

  • c6b2fabd21be1See the full diff
    • ○

      endpoint added

      endpoint-added