Skip to main content
POST
Count which selected keywords a bulk action applies to
Every bulk action takes a selection and works through it in batches:
  • selection is either { mode: "ids", ids: [trackedKeywordId, ...] } or { mode: "all", filters: { search?, country? }, excludedIds: [...] } (every keyword matching the filters, minus the excluded ids).
  • Call POST /v3/rank-tracking/keywords/bulk-preview with the selection and an action (track, untrack or delete) first. It changes nothing and returns eligibility: { selected, eligible, skipped, byReason }, e.g. keywords skipped because they are already tracked or being refreshed.
Each call processes one batch of eligible keywords and returns { success, succeeded, failed, nextCursor, eligibility, results }. While nextCursor is not null, call again with the same selection and afterId set to nextCursor. results has one entry per keyword with id, keyword, success and error when it failed. A call returns 409 if a selected keyword started refreshing mid-batch. To add new keywords by text, use Add Tracked Keyword. To change one keyword, including its active state, use PATCH /v3/rank-tracking/keywords/{id}.

Authorizations

Authorization
string
header
required

Your SnowSEO API key (sk_...).

Body

application/json
selection
object
required
action
enum<string>
required

The bulk action to count eligible rows for.

Available options:
track,
untrack,
delete
teamId
string

Response

Default Response

eligibility
object