Get page content performance report

curl --request POST \
  --url https://api.agents.writesonic.com/api/v1/business/content-intelligence/page-report \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --header 'x-project-id: <x-project-id>' \
  --data '
{
  "page_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "market_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "curr_start": "2023-12-25",
  "curr_end": "2023-12-25",
  "prev_start": "2023-12-25",
  "prev_end": "2023-12-25",
  "keyword_intent": [],
  "page": 1,
  "size": 50,
  "sort": "<string>",
  "search": "<string>",
  "category": "all",
  "cursor": "<string>"
}
'

import requests

url = "https://api.agents.writesonic.com/api/v1/business/content-intelligence/page-report"

payload = {
    "page_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "market_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "curr_start": "2023-12-25",
    "curr_end": "2023-12-25",
    "prev_start": "2023-12-25",
    "prev_end": "2023-12-25",
    "keyword_intent": [],
    "page": 1,
    "size": 50,
    "sort": "<string>",
    "search": "<string>",
    "category": "all",
    "cursor": "<string>"
}
headers = {
    "x-project-id": "<x-project-id>",
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-project-id': '<x-project-id>',
    'X-API-Key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    page_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    market_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    curr_start: '2023-12-25',
    curr_end: '2023-12-25',
    prev_start: '2023-12-25',
    prev_end: '2023-12-25',
    keyword_intent: [],
    page: 1,
    size: 50,
    sort: '<string>',
    search: '<string>',
    category: 'all',
    cursor: '<string>'
  })
};

fetch('https://api.agents.writesonic.com/api/v1/business/content-intelligence/page-report', 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.agents.writesonic.com/api/v1/business/content-intelligence/page-report",
  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([
    'page_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'market_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'curr_start' => '2023-12-25',
    'curr_end' => '2023-12-25',
    'prev_start' => '2023-12-25',
    'prev_end' => '2023-12-25',
    'keyword_intent' => [
        
    ],
    'page' => 1,
    'size' => 50,
    'sort' => '<string>',
    'search' => '<string>',
    'category' => 'all',
    'cursor' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>",
    "x-project-id: <x-project-id>"
  ],
]);

$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.agents.writesonic.com/api/v1/business/content-intelligence/page-report"

	payload := strings.NewReader("{\n  \"page_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"market_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"curr_start\": \"2023-12-25\",\n  \"curr_end\": \"2023-12-25\",\n  \"prev_start\": \"2023-12-25\",\n  \"prev_end\": \"2023-12-25\",\n  \"keyword_intent\": [],\n  \"page\": 1,\n  \"size\": 50,\n  \"sort\": \"<string>\",\n  \"search\": \"<string>\",\n  \"category\": \"all\",\n  \"cursor\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-project-id", "<x-project-id>")
	req.Header.Add("X-API-Key", "<api-key>")
	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.agents.writesonic.com/api/v1/business/content-intelligence/page-report")
  .header("x-project-id", "<x-project-id>")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"page_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"market_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"curr_start\": \"2023-12-25\",\n  \"curr_end\": \"2023-12-25\",\n  \"prev_start\": \"2023-12-25\",\n  \"prev_end\": \"2023-12-25\",\n  \"keyword_intent\": [],\n  \"page\": 1,\n  \"size\": 50,\n  \"sort\": \"<string>\",\n  \"search\": \"<string>\",\n  \"category\": \"all\",\n  \"cursor\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.agents.writesonic.com/api/v1/business/content-intelligence/page-report")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-project-id"] = '<x-project-id>'
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"page_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"market_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"curr_start\": \"2023-12-25\",\n  \"curr_end\": \"2023-12-25\",\n  \"prev_start\": \"2023-12-25\",\n  \"prev_end\": \"2023-12-25\",\n  \"keyword_intent\": [],\n  \"page\": 1,\n  \"size\": 50,\n  \"sort\": \"<string>\",\n  \"search\": \"<string>\",\n  \"category\": \"all\",\n  \"cursor\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Pages

Get page content performance report

Returns a detailed content performance report for a single tracked page, covering SEO performance, AI citations, conversion funnels, traffic, SERP position, keywords, page lifecycle, or activity.

Example: Pull the SEO performance report for one tracked page over a date range.

Usage: Set report_type to the report you want and pass the page_id to report on. The keyword, SERP, and target-keyword reports need a market to be chosen. Scope the numbers with a date window, and for the AI-citations and keyword reports you can narrow by search text. The longer reports come back in pages of up to 100 (50 by default). Resolve the page_id first by calling POST /content-intelligence/dashboard with view=pages and the page URL or title in search.

Response: the requested report for that page: its metrics, trends, and the supporting rows for the chosen report type.

POST

api

business

content-intelligence

page-report

Get page content performance report

curl --request POST \
  --url https://api.agents.writesonic.com/api/v1/business/content-intelligence/page-report \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --header 'x-project-id: <x-project-id>' \
  --data '
{
  "page_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "market_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "curr_start": "2023-12-25",
  "curr_end": "2023-12-25",
  "prev_start": "2023-12-25",
  "prev_end": "2023-12-25",
  "keyword_intent": [],
  "page": 1,
  "size": 50,
  "sort": "<string>",
  "search": "<string>",
  "category": "all",
  "cursor": "<string>"
}
'

import requests

url = "https://api.agents.writesonic.com/api/v1/business/content-intelligence/page-report"

payload = {
    "page_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "market_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "curr_start": "2023-12-25",
    "curr_end": "2023-12-25",
    "prev_start": "2023-12-25",
    "prev_end": "2023-12-25",
    "keyword_intent": [],
    "page": 1,
    "size": 50,
    "sort": "<string>",
    "search": "<string>",
    "category": "all",
    "cursor": "<string>"
}
headers = {
    "x-project-id": "<x-project-id>",
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-project-id': '<x-project-id>',
    'X-API-Key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    page_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    market_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    curr_start: '2023-12-25',
    curr_end: '2023-12-25',
    prev_start: '2023-12-25',
    prev_end: '2023-12-25',
    keyword_intent: [],
    page: 1,
    size: 50,
    sort: '<string>',
    search: '<string>',
    category: 'all',
    cursor: '<string>'
  })
};

fetch('https://api.agents.writesonic.com/api/v1/business/content-intelligence/page-report', 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.agents.writesonic.com/api/v1/business/content-intelligence/page-report",
  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([
    'page_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'market_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'curr_start' => '2023-12-25',
    'curr_end' => '2023-12-25',
    'prev_start' => '2023-12-25',
    'prev_end' => '2023-12-25',
    'keyword_intent' => [
        
    ],
    'page' => 1,
    'size' => 50,
    'sort' => '<string>',
    'search' => '<string>',
    'category' => 'all',
    'cursor' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>",
    "x-project-id: <x-project-id>"
  ],
]);

$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.agents.writesonic.com/api/v1/business/content-intelligence/page-report"

	payload := strings.NewReader("{\n  \"page_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"market_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"curr_start\": \"2023-12-25\",\n  \"curr_end\": \"2023-12-25\",\n  \"prev_start\": \"2023-12-25\",\n  \"prev_end\": \"2023-12-25\",\n  \"keyword_intent\": [],\n  \"page\": 1,\n  \"size\": 50,\n  \"sort\": \"<string>\",\n  \"search\": \"<string>\",\n  \"category\": \"all\",\n  \"cursor\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-project-id", "<x-project-id>")
	req.Header.Add("X-API-Key", "<api-key>")
	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.agents.writesonic.com/api/v1/business/content-intelligence/page-report")
  .header("x-project-id", "<x-project-id>")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"page_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"market_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"curr_start\": \"2023-12-25\",\n  \"curr_end\": \"2023-12-25\",\n  \"prev_start\": \"2023-12-25\",\n  \"prev_end\": \"2023-12-25\",\n  \"keyword_intent\": [],\n  \"page\": 1,\n  \"size\": 50,\n  \"sort\": \"<string>\",\n  \"search\": \"<string>\",\n  \"category\": \"all\",\n  \"cursor\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.agents.writesonic.com/api/v1/business/content-intelligence/page-report")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-project-id"] = '<x-project-id>'
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"page_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"market_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"curr_start\": \"2023-12-25\",\n  \"curr_end\": \"2023-12-25\",\n  \"prev_start\": \"2023-12-25\",\n  \"prev_end\": \"2023-12-25\",\n  \"keyword_intent\": [],\n  \"page\": 1,\n  \"size\": 50,\n  \"sort\": \"<string>\",\n  \"search\": \"<string>\",\n  \"category\": \"all\",\n  \"cursor\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

X-API-Key

string

header

required

Writesonic API key

Headers

x-project-id

string<uuid>

required

Project ID for tenant scoping

X-Workspace-Id

string<uuid> | null

Overrides the key's workspace

Body

application/json

report_type

enum<string>

required

report_type: Which per-page report to return. One of: seo_performance, keywords, ai_citations, geo_visibility, lifecycle_status, ai_citations_prompts, ai_citations_platforms, ai_citations_topics, ai_activity, ai_search_funnel, seo_funnel, marketing_traffic, serp_intelligence, search_referrals, content_signals, activity_log, target_keywords, metadata.

Available options:

seo_performance,

keywords,

ai_citations,

geo_visibility,

lifecycle_status,

ai_citations_prompts,

ai_citations_platforms,

ai_citations_topics,

ai_activity,

ai_search_funnel,

seo_funnel,

marketing_traffic,

serp_intelligence,

search_referrals,

content_signals,

activity_log,

target_keywords,

metadata

page_id

string<uuid>

required

The content-intelligence page to report on. Resolve it via get_ci_dashboard view=pages, search= — the page is never referred to by id in natural language.

market_id

string<uuid> | null

Market from get_ci_dashboard view=countries. Required for keywords, serp_intelligence, target_keywords and seo_funnel.

curr_start

string<date> | null

Current window start date - pairs with curr_end/prev_start/prev_end: provide all four or omit all four (defaults to trailing 30 days), else 422. Each range needs start<end, equal current/prior length, and prev_end<=curr_start.

curr_end

string<date> | null

Current window end date - see curr_start.

prev_start

string<date> | null

Comparison window start date - see curr_start.

prev_end

string<date> | null

Comparison window end date - see curr_start.

keyword_intent

enum<string>[] | null

Keyword-intent filter.

The /pages keyword_intent filter: classifies a page by whether its primary target keyword contains any of the project's brand aliases. Modelled on statuses (multi-select; both-or-none selected = no filter). An intent signal, not a traffic signal.

Available options:

branded,

non_branded

page

integer

default:1

Page number for paginated reports.

Required range: x >= 1

size

integer

default:50

Page size for paginated reports.

Required range: 1 <= x <= 100

sort

string | null

Sort for AI-citations tab reports as ':

' (dir=asc|desc); valid keys are per-tab.

string | null

Substring filter for AI-citations tab reports (prompt/platform/topic) and the keywords report.

Maximum string length: 200

Response

Successful Response

Getting Started

Identity & Project

Tasks

Agent Runs

Playbooks

Grids

Knowledge Base & Brand Kit

Pages

Integrations & Attachments

Get page content performance report

Authorizations

Headers

Body

Response