Skip to main content
POST
Count which selected topic clusters a bulk action applies to
Every bulk action takes a selection and works through it in batches:
  • selection is either { mode: "ids", ids: [topicId, ...] } or { mode: "all", filters: { search? }, excludedIds: [...] } (every cluster matching the search, minus the excluded ids).
  • Call POST /v3/topic-clusters/topics/bulk-preview with the selection and an action first. It changes nothing and returns eligibility: { selected, eligible, skipped, byReason }, e.g. clusters skipped because they are empty or already tracked.
  • POST /v3/topic-clusters/topics/selection returns the clusters a selection matches.
Each call processes one batch of eligible clusters 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 cluster with id, name, success and error when it failed. Track and untrack results also carry trackedKeywordsCreated, trackedKeywordsUpdated and promptsSkipped (prompts left untracked for lack of credits). For a single cluster, use Delete or the cluster’s tracking endpoint.

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