Skip to main content
PATCH
cURL
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:
POST /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.
GET /reports/{id}/share Return the report’s active share link as { share: { url, token } }, or { share: null } when no link exists.
DELETE /reports/share/{token} Revoke a share link by its token: clears the report’s shareToken, deletes the stored PDF, and returns { success: true }. Returns 404 if the token isn’t a live share for the team.

Email a Report

POST /reports/{id}/share/email Render the report to a PDF and email it as an attachment to one or more recipients, using the organization’s white-label email branding when configured. Each delivered send is logged to the org “Reports Sent” KPI. In addition to the rendered-page fields above, the body accepts: Returns { sent, failed } — arrays of the recipient addresses that succeeded or failed.
This route is rate-limited more tightly than the others (roughly 10 requests/minute per team) to protect email deliverability.

Export a PDF

POST /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

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Response

200

Default Response