Skip to main content
POST
Get entity counts

Authorizations

Authorization
string
header
required

A bearer token from Login, sent as Authorization: Bearer <token>. Valid for 10 days by default; scoped to the user and organisation it was issued for. Rotating or disabling the organisation's API credential immediately invalidates all outstanding tokens. Browser calls from a signed-in app.vortexiq.ai page are also accepted via session cookie — see Authentication.

Body

application/json

Counts and forecast read the source store only, so destination_store_hash is optional.

source_store_hash
string
required

BigCommerce store hash to read.

selected_entities
string[]
required

Entity keys to count or price. Required except with mode: true-replica, where the platform expands its own preset and this field must be omitted.

Minimum array length: 1
destination_store_hash
string

Optional and currently unused — /entity-counts and /forecast are source-only reads. Destination-aware pricing of update/replace happens only at kickoff (POST /migrations).

mode
string

Optional. true-replica sizes the server-configured True Replica preset instead of a caller-supplied entity list (subject to the same organisation gate as Create migration).

selection
object

Selective migration picks. Parents and ancestors are included automatically, and products pull in their brands and categories.

Find the ids to pass here in the StagingPro app's Selective Migration tab. A selection also scopes entity counts and the forecast.

conflict_strategy
enum<string>

Forecast only: price the ETA for this strategy.

Available options:
skip,
update,
replace
channel_map
object

Optional channel map.

source_channel_id
integer

Optional storefront scope.

Required range: x >= 1
destination_channel_id
integer

Optional storefront scope.

Required range: x >= 1

Response

Entity counts. Keys listed in estimated are sampled estimates rather than exact totals.

counts
object

Entity key → total on the source store.

estimated
string[]

Keys whose value is a sampled estimate.

at
string<date-time>