Get content-intelligence dashboard

curl --request POST \
  --url https://api.example.com/api/v1/business/content-intelligence/dashboard \
  --header 'Content-Type: application/json' \
  --header 'x-project-id: <x-project-id>' \
  --data '
{
  "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",
  "search": "<string>",
  "statuses": [],
  "keyword_intent": [],
  "group_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "sort": "<string>",
  "page": 1,
  "size": 50
}
'

import requests

url = "https://api.example.com/api/v1/business/content-intelligence/dashboard"

payload = {
    "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",
    "search": "<string>",
    "statuses": [],
    "keyword_intent": [],
    "group_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "sort": "<string>",
    "page": 1,
    "size": 50
}
headers = {
    "x-project-id": "<x-project-id>",
    "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>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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',
    search: '<string>',
    statuses: [],
    keyword_intent: [],
    group_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    sort: '<string>',
    page: 1,
    size: 50
  })
};

fetch('https://api.example.com/api/v1/business/content-intelligence/dashboard', 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.example.com/api/v1/business/content-intelligence/dashboard",
  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([
    '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',
    'search' => '<string>',
    'statuses' => [
        
    ],
    'keyword_intent' => [
        
    ],
    'group_ids' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ],
    'sort' => '<string>',
    'page' => 1,
    'size' => 50
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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.example.com/api/v1/business/content-intelligence/dashboard"

	payload := strings.NewReader("{\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  \"search\": \"<string>\",\n  \"statuses\": [],\n  \"keyword_intent\": [],\n  \"group_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"sort\": \"<string>\",\n  \"page\": 1,\n  \"size\": 50\n}")

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

	req.Header.Add("x-project-id", "<x-project-id>")
	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.example.com/api/v1/business/content-intelligence/dashboard")
  .header("x-project-id", "<x-project-id>")
  .header("Content-Type", "application/json")
  .body("{\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  \"search\": \"<string>\",\n  \"statuses\": [],\n  \"keyword_intent\": [],\n  \"group_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"sort\": \"<string>\",\n  \"page\": 1,\n  \"size\": 50\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/business/content-intelligence/dashboard")

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["Content-Type"] = 'application/json'
request.body = "{\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  \"search\": \"<string>\",\n  \"statuses\": [],\n  \"keyword_intent\": [],\n  \"group_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"sort\": \"<string>\",\n  \"page\": 1,\n  \"size\": 50\n}"

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

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

Content Intelligence

Get content-intelligence dashboard

Project-level content-intelligence reads: page summary, live summary, available filters, countries, the ranked page list, page groups, and the page-list column scope, selected by view. view=pages is also how a page named in natural language (by URL/title) is resolved to the page_id get_page_report needs. view=filters is the discovery call for the pages list’s sort/filter metric keys and named presets (e.g. ‘declining pages’) — call it before guessing a sort key. view=groups resolves a page-group NAME (filter with search) to the group_id view=pages/summary’s group_ids param needs — group_ids is never guessable, always resolve it here first.

POST

api

business

content-intelligence

dashboard

Get content-intelligence dashboard

curl --request POST \
  --url https://api.example.com/api/v1/business/content-intelligence/dashboard \
  --header 'Content-Type: application/json' \
  --header 'x-project-id: <x-project-id>' \
  --data '
{
  "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",
  "search": "<string>",
  "statuses": [],
  "keyword_intent": [],
  "group_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "sort": "<string>",
  "page": 1,
  "size": 50
}
'

import requests

url = "https://api.example.com/api/v1/business/content-intelligence/dashboard"

payload = {
    "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",
    "search": "<string>",
    "statuses": [],
    "keyword_intent": [],
    "group_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "sort": "<string>",
    "page": 1,
    "size": 50
}
headers = {
    "x-project-id": "<x-project-id>",
    "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>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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',
    search: '<string>',
    statuses: [],
    keyword_intent: [],
    group_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    sort: '<string>',
    page: 1,
    size: 50
  })
};

fetch('https://api.example.com/api/v1/business/content-intelligence/dashboard', 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.example.com/api/v1/business/content-intelligence/dashboard",
  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([
    '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',
    'search' => '<string>',
    'statuses' => [
        
    ],
    'keyword_intent' => [
        
    ],
    'group_ids' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ],
    'sort' => '<string>',
    'page' => 1,
    'size' => 50
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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.example.com/api/v1/business/content-intelligence/dashboard"

	payload := strings.NewReader("{\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  \"search\": \"<string>\",\n  \"statuses\": [],\n  \"keyword_intent\": [],\n  \"group_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"sort\": \"<string>\",\n  \"page\": 1,\n  \"size\": 50\n}")

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

	req.Header.Add("x-project-id", "<x-project-id>")
	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.example.com/api/v1/business/content-intelligence/dashboard")
  .header("x-project-id", "<x-project-id>")
  .header("Content-Type", "application/json")
  .body("{\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  \"search\": \"<string>\",\n  \"statuses\": [],\n  \"keyword_intent\": [],\n  \"group_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"sort\": \"<string>\",\n  \"page\": 1,\n  \"size\": 50\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/business/content-intelligence/dashboard")

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["Content-Type"] = 'application/json'
request.body = "{\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  \"search\": \"<string>\",\n  \"statuses\": [],\n  \"keyword_intent\": [],\n  \"group_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"sort\": \"<string>\",\n  \"page\": 1,\n  \"size\": 50\n}"

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

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

Headers

x-project-id

string<uuid>

required

Project ID for tenant scoping

X-Workspace-Id

string<uuid> | null

Overrides the key's workspace

X-API-Key

string | null

User API key

Body

application/json

view

enum<string>

required

Which dashboard read to return.

Available options:

countries,

filters,

summary,

live_summary,

pages,

column_scope,

groups

market_id

string<uuid> | null

Market (country) to scope metrics to.

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.

string | null

Filter pages by URL/title substring.

statuses

enum<string>[] | null

Filter the page list by lifecycle status.

The unified /pages status filter: distinct union of performance + content status values (performance order first, then content-only). Routing onto the two columns is by membership in the two source enums; the shared stable matches both. Kept in sync via a drift-guard test.

Available options:

pruned,

redirect,

not_indexed,

cannibalizing,

underperforming,

new,

stable,

rising,

declining,

dormant,

stale,

thin

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

group_ids

string<uuid>[] | null

Filter the page list by page-group id.

sort

string | null

Sort the page list as ':

' (dir=asc|desc). Common keys: traffic, clicks, impressions, position, citations, citation_share, ai_bot_hits — and each one's _change/_change_pct trend variant (e.g. clicks_change_pct, ai_citation_count_change) for window-over-window ranking ('which pages gained/lost the most'), paired with curr_start/curr_end/prev_start/prev_end to set the two windows being compared. Call view=filters first for this project's current key list plus named presets (e.g. pages getting fewer clicks, sinking in rankings) that bundle a ready-made filter+sort.

page

integer

default:1

Page number for the pages list.

Required range: x >= 1

size

integer

default:50

Page size for the pages list.

Required range: 1 <= x <= 100

Response

Successful Response

⌘I

Getting Started

Identity & Project

Tasks

Agent Runs

Playbooks

Grids

Knowledge & Brand

Content Intelligence

Integrations & Attachments

Get content-intelligence dashboard

Headers

Body

Response