Skip to content

Preview Keyword Urls

POST
/intent/keywords/preview

Estimate how many URLs a keyword and filters would match, WITHOUT creating it.

Reads pages already crawled; starts no crawl and creates nothing. Returns estimated_url_count, baseline_url_count and a filter_impact breakdown.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

What a keyword WOULD match, without creating it.

object
keyword
required

The keyword to preview.

string
>= 1 characters
search_filters

Filters to preview it with.

object
audience

b2b, b2c or both.

string
default: both
Allowed values: b2b b2c both
exclude_domains

Domains to drop.

Array<string>
exclude_page_types

Page types to drop from the URL set.

Array<string>
Allowed values: news finance forum vendor_marketing
llm_triage

Run a model pass over candidate pages.

boolean
max_urls_per_domain

Soft cap so no single domain dominates the set.

integer
default: 5 >= 1 <= 20
min_commercial_intent_level

Drop pages scored below this commercial intent.

integer
<= 100
key
additional properties
any

Responses

200

Successful Response

object
data
required

One intent object or handler response.

Open-shaped: these payloads carry corpus detail that grows with the corpus. A list result is returned under items.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string