Create a report share link
curl --request POST \
--url https://api.snowseo.com/v3/reports/{id}/share/link \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"pages": [
{
"image": "<string>",
"branding": {
"x": 123,
"y": 123,
"w": 123,
"h": 123,
"disableWhiteLabel": true
}
}
],
"pageWidth": 123,
"pageHeight": 123,
"title": "<string>",
"author": "<string>"
}
'import requests
url = "https://api.snowseo.com/v3/reports/{id}/share/link"
payload = {
"pages": [
{
"image": "<string>",
"branding": {
"x": 123,
"y": 123,
"w": 123,
"h": 123,
"disableWhiteLabel": True
}
}
],
"pageWidth": 123,
"pageHeight": 123,
"title": "<string>",
"author": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
pages: [
{
image: '<string>',
branding: {x: 123, y: 123, w: 123, h: 123, disableWhiteLabel: true}
}
],
pageWidth: 123,
pageHeight: 123,
title: '<string>',
author: '<string>'
})
};
fetch('https://api.snowseo.com/v3/reports/{id}/share/link', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.snowseo.com/v3/reports/{id}/share/link",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'pages' => [
[
'image' => '<string>',
'branding' => [
'x' => 123,
'y' => 123,
'w' => 123,
'h' => 123,
'disableWhiteLabel' => true
]
]
],
'pageWidth' => 123,
'pageHeight' => 123,
'title' => '<string>',
'author' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.snowseo.com/v3/reports/{id}/share/link"
payload := strings.NewReader("{\n \"pages\": [\n {\n \"image\": \"<string>\",\n \"branding\": {\n \"x\": 123,\n \"y\": 123,\n \"w\": 123,\n \"h\": 123,\n \"disableWhiteLabel\": true\n }\n }\n ],\n \"pageWidth\": 123,\n \"pageHeight\": 123,\n \"title\": \"<string>\",\n \"author\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.snowseo.com/v3/reports/{id}/share/link")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"pages\": [\n {\n \"image\": \"<string>\",\n \"branding\": {\n \"x\": 123,\n \"y\": 123,\n \"w\": 123,\n \"h\": 123,\n \"disableWhiteLabel\": true\n }\n }\n ],\n \"pageWidth\": 123,\n \"pageHeight\": 123,\n \"title\": \"<string>\",\n \"author\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.snowseo.com/v3/reports/{id}/share/link")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"pages\": [\n {\n \"image\": \"<string>\",\n \"branding\": {\n \"x\": 123,\n \"y\": 123,\n \"w\": 123,\n \"h\": 123,\n \"disableWhiteLabel\": true\n }\n }\n ],\n \"pageWidth\": 123,\n \"pageHeight\": 123,\n \"title\": \"<string>\",\n \"author\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"url": "<string>",
"token": "<string>"
}Reports
Report Sharing & Delivery
Share reports as public links, email them as PDF, and revoke access - with white-label branding.
POST
/
v3
/
reports
/
{id}
/
share
/
link
Create a report share link
curl --request POST \
--url https://api.snowseo.com/v3/reports/{id}/share/link \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"pages": [
{
"image": "<string>",
"branding": {
"x": 123,
"y": 123,
"w": 123,
"h": 123,
"disableWhiteLabel": true
}
}
],
"pageWidth": 123,
"pageHeight": 123,
"title": "<string>",
"author": "<string>"
}
'import requests
url = "https://api.snowseo.com/v3/reports/{id}/share/link"
payload = {
"pages": [
{
"image": "<string>",
"branding": {
"x": 123,
"y": 123,
"w": 123,
"h": 123,
"disableWhiteLabel": True
}
}
],
"pageWidth": 123,
"pageHeight": 123,
"title": "<string>",
"author": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
pages: [
{
image: '<string>',
branding: {x: 123, y: 123, w: 123, h: 123, disableWhiteLabel: true}
}
],
pageWidth: 123,
pageHeight: 123,
title: '<string>',
author: '<string>'
})
};
fetch('https://api.snowseo.com/v3/reports/{id}/share/link', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.snowseo.com/v3/reports/{id}/share/link",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'pages' => [
[
'image' => '<string>',
'branding' => [
'x' => 123,
'y' => 123,
'w' => 123,
'h' => 123,
'disableWhiteLabel' => true
]
]
],
'pageWidth' => 123,
'pageHeight' => 123,
'title' => '<string>',
'author' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.snowseo.com/v3/reports/{id}/share/link"
payload := strings.NewReader("{\n \"pages\": [\n {\n \"image\": \"<string>\",\n \"branding\": {\n \"x\": 123,\n \"y\": 123,\n \"w\": 123,\n \"h\": 123,\n \"disableWhiteLabel\": true\n }\n }\n ],\n \"pageWidth\": 123,\n \"pageHeight\": 123,\n \"title\": \"<string>\",\n \"author\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.snowseo.com/v3/reports/{id}/share/link")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"pages\": [\n {\n \"image\": \"<string>\",\n \"branding\": {\n \"x\": 123,\n \"y\": 123,\n \"w\": 123,\n \"h\": 123,\n \"disableWhiteLabel\": true\n }\n }\n ],\n \"pageWidth\": 123,\n \"pageHeight\": 123,\n \"title\": \"<string>\",\n \"author\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.snowseo.com/v3/reports/{id}/share/link")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"pages\": [\n {\n \"image\": \"<string>\",\n \"branding\": {\n \"x\": 123,\n \"y\": 123,\n \"w\": 123,\n \"h\": 123,\n \"disableWhiteLabel\": true\n }\n }\n ],\n \"pageWidth\": 123,\n \"pageHeight\": 123,\n \"title\": \"<string>\",\n \"author\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"url": "<string>",
"token": "<string>"
}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
The share and export routes accept the same rendered-page body the editor sends:
Request bodies are limited to 50MB.
Generate a server-stamped PDF of the report and return it as a file download (
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.
| Field | Description |
|---|---|
pages | Required. Array of rendered pages, each with an image (data URL) and optional branding box (x, y, w, h, disableWhiteLabel) |
pageWidth | Required. Page width in pixels |
pageHeight | Required. Page height in pixels |
orientation | Optional portrait or landscape. Accepted but ignored - the PDF uses pageWidth and pageHeight |
title | Report title used for the PDF filename and metadata |
author | Optional author metadata |
Create a Share Link
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.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
| Field | Description |
|---|---|
pages | Required. Array of { image, branding? } - image must be a data URL |
pageWidth | Required. Page width (number) |
pageHeight | Required. Page height (number) |
orientation | Optional portrait or landscape. Accepted but ignored |
title | Optional title (used for the PDF filename) |
author | Optional author metadata |
Responses
| Status | Body |
|---|---|
200 | Binary PDF (application/pdf) |
400 | { error } - missing teamId, missing/invalid pages or dimensions, or a page image that is not a data:image/ URL (All page images must be data:image/ URLs) |
401 | { error } - no session |
403 | { error } - you are not a member of the team |
404 | { error } - report not found for the team |
413 | { error } - request body over 50MB |
429 | { error } - rate limit exceeded (60 requests per minute for report routes) |
500 | { error } - PDF generation failed. Other 5xx codes are possible |
Authorizations
bearerAuthapiKey
Your SnowSEO API key (sk_...).
Path Parameters
Body
application/json
Was this page helpful?

