Get content-intelligence dashboard

Returns project-level content-intelligence data for the dashboard: page and live-tracking summaries, the available filters and countries, the ranked list of tracked pages, page groups, and the columns shown in the page list.

Example: “List the Pages I’m tracking”

Usage: pick what you want with view: summary and live_summary for the headline numbers, countries and filters for the choices you can filter and sort by, pages for the ranked page list, groups for named page groups, and column_scope for the page-list columns. Scope the numbers with a market and a date window, and narrow the page list by search text, status, keyword intent, or group. The page list comes back in pages of up to 100 (50 by default). Use view=pages with a URL or title in search to find the page id other reports need, and view=filters to learn the real sort keys and ready-made presets before sorting.

Response: the data for the chosen view: summary metrics, the list of countries or filters, the ranked pages with their metrics, the page groups, or the page-list columns.

POST /api/v1/business/content-intelligence/dashboard

Get content-intelligence dashboard

cURL

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
}
'

422

{
  "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.

search · 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

200

application/json

Successful Response