curl --request GET \
--url https://app.surferseo.com/api/v2/workspaces/{workspace_id}/content_editors/{content_editor_id}/seo_guidelines \
--header 'API-KEY: <api-key>'import requests
url = "https://app.surferseo.com/api/v2/workspaces/{workspace_id}/content_editors/{content_editor_id}/seo_guidelines"
headers = {"API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'API-KEY': '<api-key>'}};
fetch('https://app.surferseo.com/api/v2/workspaces/{workspace_id}/content_editors/{content_editor_id}/seo_guidelines', 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://app.surferseo.com/api/v2/workspaces/{workspace_id}/content_editors/{content_editor_id}/seo_guidelines",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.surferseo.com/api/v2/workspaces/{workspace_id}/content_editors/{content_editor_id}/seo_guidelines"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("API-KEY", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.surferseo.com/api/v2/workspaces/{workspace_id}/content_editors/{content_editor_id}/seo_guidelines")
.header("API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.surferseo.com/api/v2/workspaces/{workspace_id}/content_editors/{content_editor_id}/seo_guidelines")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"inserted_at": "2024-04-12T15:23:45Z",
"can_load_more_competitors": true,
"competitors": [
{
"description": "Compare the top SEO tools to grow organic traffic, audit your site, and outrank competitors.",
"domain_score": 67,
"id": 4521,
"included": true,
"position": 3,
"score": 82,
"title": "10 Best SEO Tools in 2025",
"url": "https://example.com/best-seo-tools"
}
],
"id": 123,
"load_more_status": "idle",
"score": 78,
"status": "completed",
"structure": {
"guidelines_baseline": "word_count",
"structural_guidelines": [
{
"factor": "character_count",
"target": {
"avg": 6.28,
"max": 11.21,
"min": 1.35,
"value_override": null
}
},
{
"factor": "headings_count",
"target": {
"avg": 0.007,
"max": 0.014,
"min": 0.005,
"value_override": null
}
},
{
"factor": "paragraph_count",
"target": {
"avg": 0.02,
"max": 0.035,
"min": 0,
"value_override": null
}
},
{
"factor": "img_count",
"target": {
"avg": 0.003,
"max": 0.01,
"min": 0,
"value_override": null
}
}
],
"word_count": 1800
},
"terms": [
{
"heading": false,
"included": true,
"item": "seo tools",
"target_range": {
"max": 9,
"min": 5
}
}
],
"topics_and_questions": [
{
"included": true,
"item": "keyword research",
"type": "surfer"
}
],
"updated_at": "2024-06-01T09:17:33Z"
}{
"error": {
"details": [
{
"field": "keywords",
"reason": "required"
}
],
"reason": "validation_error"
}
}{
"error": {
"details": [],
"reason": "unauthorized"
}
}{
"error": {
"details": [],
"reason": "permission_denied"
}
}{
"error": {
"details": [],
"reason": "not_found"
}
}{
"error": {
"details": [
{
"allowed": [
"application/json"
],
"field": "accept",
"reason": "unsupported"
}
],
"message": "Accept must be one of: application/json",
"reason": "not_acceptable"
}
}{
"error": {
"details": [],
"message": "The request conflicts with the current resource state.",
"reason": "conflict"
}
}{
"error": {
"details": [
{
"retry_after": 30
}
],
"reason": "rate_limit_exceeded"
}
}Get SEO Guidelines
Returns the full SEO Guidelines for a Content Editor — id, status, score,
can_load_more_competitors, load_more_status, timestamps, the structure block,
and plain competitors, terms, and topics_and_questions arrays (item shapes match
.data from the dedicated sub-endpoints). Requires the editor to be in completed
state — scheduled, executing, and failed editors return 409.
Response size: scales with the editor’s competitor/term/topic counts and can be
large. For id, status, score, can_load_more_competitors, load_more_status,
and timestamps use /status; for a single sub-block use /score, /structure,
/competitors, /terms, or /topics_and_questions.
Score updates: the SEO score recalculates asynchronously; content_editor.seo_score.calculated
/ .failed signal completion. Poll /seo_guidelines/score (its status / calculated_at) as a fallback.
Rate limit: 10 requests/sec
curl --request GET \
--url https://app.surferseo.com/api/v2/workspaces/{workspace_id}/content_editors/{content_editor_id}/seo_guidelines \
--header 'API-KEY: <api-key>'import requests
url = "https://app.surferseo.com/api/v2/workspaces/{workspace_id}/content_editors/{content_editor_id}/seo_guidelines"
headers = {"API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'API-KEY': '<api-key>'}};
fetch('https://app.surferseo.com/api/v2/workspaces/{workspace_id}/content_editors/{content_editor_id}/seo_guidelines', 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://app.surferseo.com/api/v2/workspaces/{workspace_id}/content_editors/{content_editor_id}/seo_guidelines",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.surferseo.com/api/v2/workspaces/{workspace_id}/content_editors/{content_editor_id}/seo_guidelines"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("API-KEY", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.surferseo.com/api/v2/workspaces/{workspace_id}/content_editors/{content_editor_id}/seo_guidelines")
.header("API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.surferseo.com/api/v2/workspaces/{workspace_id}/content_editors/{content_editor_id}/seo_guidelines")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"inserted_at": "2024-04-12T15:23:45Z",
"can_load_more_competitors": true,
"competitors": [
{
"description": "Compare the top SEO tools to grow organic traffic, audit your site, and outrank competitors.",
"domain_score": 67,
"id": 4521,
"included": true,
"position": 3,
"score": 82,
"title": "10 Best SEO Tools in 2025",
"url": "https://example.com/best-seo-tools"
}
],
"id": 123,
"load_more_status": "idle",
"score": 78,
"status": "completed",
"structure": {
"guidelines_baseline": "word_count",
"structural_guidelines": [
{
"factor": "character_count",
"target": {
"avg": 6.28,
"max": 11.21,
"min": 1.35,
"value_override": null
}
},
{
"factor": "headings_count",
"target": {
"avg": 0.007,
"max": 0.014,
"min": 0.005,
"value_override": null
}
},
{
"factor": "paragraph_count",
"target": {
"avg": 0.02,
"max": 0.035,
"min": 0,
"value_override": null
}
},
{
"factor": "img_count",
"target": {
"avg": 0.003,
"max": 0.01,
"min": 0,
"value_override": null
}
}
],
"word_count": 1800
},
"terms": [
{
"heading": false,
"included": true,
"item": "seo tools",
"target_range": {
"max": 9,
"min": 5
}
}
],
"topics_and_questions": [
{
"included": true,
"item": "keyword research",
"type": "surfer"
}
],
"updated_at": "2024-06-01T09:17:33Z"
}{
"error": {
"details": [
{
"field": "keywords",
"reason": "required"
}
],
"reason": "validation_error"
}
}{
"error": {
"details": [],
"reason": "unauthorized"
}
}{
"error": {
"details": [],
"reason": "permission_denied"
}
}{
"error": {
"details": [],
"reason": "not_found"
}
}{
"error": {
"details": [
{
"allowed": [
"application/json"
],
"field": "accept",
"reason": "unsupported"
}
],
"message": "Accept must be one of: application/json",
"reason": "not_acceptable"
}
}{
"error": {
"details": [],
"message": "The request conflicts with the current resource state.",
"reason": "conflict"
}
}{
"error": {
"details": [
{
"retry_after": 30
}
],
"reason": "rate_limit_exceeded"
}
}Authorizations
Path Parameters
x >= 1123
x >= 1123
Response
SEO Guidelines
"2024-04-12T15:23:45Z"
true
Show child attributes
Show child attributes
x >= 1123
executing, idle "idle"
0 <= x <= 10078
completed, executing, failed, scheduled "completed"
Show child attributes
Show child attributes
{
"guidelines_baseline": "word_count",
"structural_guidelines": [
{
"factor": "character_count",
"target": {
"avg": 6.28,
"max": 11.21,
"min": 1.35,
"value_override": null
}
},
{
"factor": "headings_count",
"target": {
"avg": 0.007,
"max": 0.014,
"min": 0.005,
"value_override": null
}
},
{
"factor": "paragraph_count",
"target": {
"avg": 0.02,
"max": 0.035,
"min": 0,
"value_override": null
}
},
{
"factor": "img_count",
"target": {
"avg": 0.003,
"max": 0.01,
"min": 0,
"value_override": null
}
}
],
"word_count": 1800
}
Show child attributes
Show child attributes
Show child attributes
Show child attributes
"2024-06-01T09:17:33Z"
Was this page helpful?