Save Seo Tracked Keywords

POST

/seo/rank-tracking/keywords

• Production
• QA

SPENDS NOTHING NOW. Start tracking up to 100 keywords for a domain.

The rank checks themselves run in the background worker on the chosen cadence; saving enrols the organisation in that worker’s tick. The saved rows come back with whatever the worker has already recorded. Duplicates of an existing keyword are refused with a 422 naming them.

Authorizations

• BearerAuth

Parameters

Header Parameters

X-Target-Org-Id

Any of:

string

string

null

null

Request Body ^required

Mirrors SaveTrackedKeywordsRequest.

domain is normalised by the app (lower-cased, www. stripped) and refused with a 422 if it carries a scheme or a path.

object

cadence

Any of:

string

string

Allowed values: daily weekly manual

null

null

domain

required

string

>= 3 characters <= 255 characters

keywords

required

Array<object>

>= 1 items <= 100 items

Mirrors TrackKeywordItem.

object

keyword

required

string

>= 1 characters <= 500 characters

search_volume

Any of:

integer

integer

null

null

language_code

Any of:

string

string

<= 10 characters

null

null

location_code

Any of:

integer

integer

null

null

Responses

200

Successful Response

object

data

required

Array<object>

Mirrors TrackedKeywordDTO. companies_28d / deals_open are those of the keyword’s ranking page (an estimate of who arrived for it).

object

ai_overview

Any of:

SeoTrackedAiOverview

Mirrors TrackedAiOverviewDTO.

object

cited

Any of:

boolean

boolean

null

null

cited_domains

Array<string>

default:

present

Any of:

boolean

boolean

null

null

null

null

best_page

Any of:

string

string

null

null

cadence

required

string

change

Any of:

integer

integer

null

null

companies_28d

Any of:

integer

integer

null

null

created_at

Any of:

string

string format: date-time

null

null

deals_open

Any of:

integer

integer

null

null

difficulty

Any of:

integer

integer

null

null

domain

required

string

est_clicks

Any of:

integer

integer

null

null

id

required

string format: uuid

is_brand

boolean

is_deal_page

boolean

is_money

boolean

keyword

required

string

language_code

required

string

latest_checked_at

Any of:

string

string format: date-time

null

null

latest_rank

Any of:

integer

integer

null

null

latest_serp_depth

Any of:

integer

integer

null

null

latest_serp_url

Any of:

string

string

null

null

location_code

required

integer

search_volume

Any of:

integer

integer

null

null

serp_depth

Any of:

integer

integer

null

null

serp_features

Array<string>

default:

tags

Array<string>

default:

volume_refreshed_at

Any of:

string

string format: date-time

null

null

zero_click_share

Any of:

number

number

null

null

zero_click_source

Any of:

string

string

Allowed values: clickstream estimate

null

null

pagination

Any of:

PaginationMeta

object

has_next

required

Whether there are more pages

boolean

limit

required

Items per page

integer

next_cursor

Any of:

string

string

null

null

notes

Any of:

Array<string>

Array<string>

null

null

page

required

Current page number (1-indexed)

integer

total

required

Total number of items

integer

total_available

Any of:

integer

integer

null

null

total_is_lower_bound

Any of:

boolean

boolean

null

null

null

null

422

Validation Error

object

detail

Array<object>

object

loc

required

Array

msg

required

string

type

required

string