Skip to content

Save Seo Tracked Keywords

POST
/seo/rank-tracking/keywords

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

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

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
string
default: daily
Allowed values: daily weekly
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
language_code
string
default: en <= 10 characters
location_code
integer
default: 2840

Responses

200

Successful Response

object
data
required
Array<object>

Mirrors TrackedKeywordDTO.

object
cadence
required
string
created_at
Any of:
string format: date-time
domain
required
string
id
required
string format: uuid
keyword
required
string
language_code
required
string
latest_checked_at
Any of:
string format: date-time
latest_rank
Any of:
integer
latest_serp_url
Any of:
string
location_code
required
integer
search_volume
Any of:
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