Get entity counts

Exact totals on the source store for the entities you selected — the numbers behind the count badges in the StagingPro UI. Fast, parallel reads; no run is created and the destination is never touched.

destination_store_hash is optional here, so you can get counts with only a source store chosen. Pass a selection to scope the counts to a selective run’s real picks rather than the whole store. Orders are counted per selected order_status_{id} when those keys are requested.

POST /entity-counts

Get entity counts

cURL

curl --request POST \
  --url https://app.vortexiq.ai/v2/api/bc-migration/entity-counts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "source_store_hash": "abc123xyz",
  "selected_entities": [
    "products",
    "categories",
    "brands"
  ]
}
'

import requests

url = "https://app.vortexiq.ai/v2/api/bc-migration/entity-counts"

payload = {
    "source_store_hash": "abc123xyz",
    "selected_entities": ["products", "categories", "brands"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    source_store_hash: 'abc123xyz',
    selected_entities: ['products', 'categories', 'brands']
  })
};

fetch('https://app.vortexiq.ai/v2/api/bc-migration/entity-counts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.vortexiq.ai/v2/api/bc-migration/entity-counts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'source_store_hash' => 'abc123xyz',
    'selected_entities' => [
        'products',
        'categories',
        'brands'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.vortexiq.ai/v2/api/bc-migration/entity-counts"

	payload := strings.NewReader("{\n  \"source_store_hash\": \"abc123xyz\",\n  \"selected_entities\": [\n    \"products\",\n    \"categories\",\n    \"brands\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.vortexiq.ai/v2/api/bc-migration/entity-counts")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"source_store_hash\": \"abc123xyz\",\n  \"selected_entities\": [\n    \"products\",\n    \"categories\",\n    \"brands\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.vortexiq.ai/v2/api/bc-migration/entity-counts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"source_store_hash\": \"abc123xyz\",\n  \"selected_entities\": [\n    \"products\",\n    \"categories\",\n    \"brands\"\n  ]\n}"

response = http.request(request)
puts response.read_body

200

{
  "counts": {
    "products": 1200,
    "categories": 210,
    "brands": 40
  },
  "estimated": [],
  "at": "2026-07-16T09:00:00.000Z"
}

{
  "message": "Store Migration is not enabled for this organization."
}

{
  "error": "store_not_found",
  "message": "source or destination store not found / not authorized for this organization"
}

{
  "error": "<string>",
  "message": "<string>",
  "status": 123,
  "errors": {}
}

Authorizations

Authorization · string · header · required

A bearer token from Login, sent as Authorization: Bearer <token>. Valid for 10 days; 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.

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.

Show child attributes

conflict_strategy · enum<string>

Forecast only: price the ETA for this strategy.

Available options: skip, update, replace

channel_map · object

Optional channel map.

Show child attributes

source_channel_id · integer

Optional storefront scope.

Required range: x >= 1

destination_channel_id · integer

Optional storefront scope.

Required range: x >= 1

Response

200

application/json

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

counts · object

Entity key → total on the source store.

Show child attributes

estimated · string[]

Keys whose value is a sampled estimate.

at · string<date-time>