Skip to main content
POST
Count which selected reports a bulk action applies to
Bulk actions take a selection and work through it in batches:
  • selection is either { mode: "ids", ids: [reportId, ...] } or { mode: "all", filters: { search? }, excludedIds: [...] } (every report matching the filters, minus the excluded ids).
  • Call POST /v3/reports/bulk-preview with the selection and an action first. It changes nothing and returns eligibility: { selected, eligible, skipped, byReason }.
Each call processes one batch 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 report with id, success and error when it failed. For a single report, use Delete a Report.

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:
delete
teamId
string

Response

Default Response

eligibility
object