Skip to main content
POST
Create a keyword research job

Authorizations

Authorization
string
header
required

API key for programmatic access. Create keys in Settings (Agency plan). Send as Authorization: Bearer or X-API-KEY: . Unauthenticated requests return 401.

Body

application/json
primaryDomain
string
required

Primary domain to analyze (e.g. example.com)

Example:

"example.com"

languageCode
string
required

Language code (e.g. en)

locationCode
integer
required

Location code (e.g. 2840 for United States)

competitorDomains
string[]

Optional competitor domains

Maximum array length: 10
Example:

Response

Job created; pipeline started

job
object