Skip to content

Research Seo Keywords

POST
/seo/keywords/research

SPENDS CREDITS. Keyword ideas around a seed, from the paid data provider.

mode picks the provider report: ideas, related, suggestions, or auto to let the app choose. Rows come back in that report’s own shape.

Runs the app’s per-organisation provider rate limit (429 past it) and its fail-closed credit check (402 when the balance is exhausted) before anything is fetched. A provider outage is a 502 that says so.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Mirrors ResearchKeywordsRequest.

limit is capped at 150 - the same ceiling the app, the agent tool and the UI share - so a larger ask is a 422 here rather than a silent truncation.

object
language_code
string
default: en <= 10 characters
limit
integer
default: 150 >= 1 <= 150
location_code
integer
default: 2840
mode
string
default: auto
Allowed values: auto ideas related suggestions
seed_keyword
required
string
>= 1 characters <= 500 characters

Responses

200

Successful Response

object
data
required

Mirrors ResearchKeywordsResponse.

keywords rows are the provider’s row shape for the chosen mode, passed through rather than flattened, because the four modes return different columns and flattening would drop the ones a caller asked for.

object
keywords
Array<object>
default:
object
key
additional properties
any
seed
Any of:

Mirrors KeywordRow.

object
competition
number
cpc
number
intent
Any of:
string
keyword
required
string
keyword_difficulty
Any of:
integer
search_volume
integer
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

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