Skip to main content
POST
Get entity counts

Authorizations

vortexiq_session
string
cookie
required

Your signed-in Vortex IQ session (browser calls). Requests are scoped to your organisation, which must have Store Migration enabled. For server-to-server calls use a bearer token instead — 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.

Minimum array length: 1
destination_store_hash
string

Optional. Supplying it lets the forecast price update/replace against the destination's real size.

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>