Skip to main content
POST
Create a report share link
Share a Report Builder report outside your team: generate a public viewer link, email the report as a PDF, or revoke a link at any time. All routes are team-scoped and require the member role.
On non-Scale plans, generated PDFs carry a small SnowSEO watermark and brand-mark. On the Scale plan (with white-label configured for the organization), the watermark is suppressed and your own branding is stamped instead.
The share and export routes accept the same rendered-page body the editor sends: Request bodies are limited to 50MB.
POST /v3/reports/{id}/share/link Render the report to a PDF, upload it to storage, and mint a public shareToken. Returns { url, token }, where url is the public viewer link (/r/{token}). Re-generating replaces the previous share object. Body is the rendered-page payload above.

Export a PDF

POST /v3/reports/{id}/export-pdf
This endpoint is hidden from the interactive API reference (hide: true). It streams a binary PDF response rather than JSON.
Generate a server-stamped PDF of the report and return it as a file download (Content-Type: application/pdf, Content-Disposition: attachment). The watermark / brand-mark is applied server-side based on the organization’s white-label status.

Request body

Responses

Authorizations

Authorization
string
header
required

Your SnowSEO API key (sk_...).

Path Parameters

id
string
required

Body

application/json
pages
object[]
required
pageWidth
number
required

Page width.

pageHeight
number
required

Page height.

orientation
enum<string>
Available options:
portrait,
landscape
title
string

Document title, also used for the PDF filename.

author
string

Author metadata.

Response

200 - application/json

Default Response

url
string<uri>
required
token
string
required