Get migration

Full run detail: status, per-phase progress, counters, and the forecast.

A finished run is served from the durable snapshot (so it survives engine teardown); a live run is read straight from the engine for real-time state. Either way the response shape is the same.

GET /migrations/{id}

Get migration

cURL

curl --request GET \
  --url https://app.vortexiq.ai/v2/api/bc-migration/migrations/{id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://app.vortexiq.ai/v2/api/bc-migration/migrations/{id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://app.vortexiq.ai/v2/api/bc-migration/migrations/{id}', 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/migrations/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://app.vortexiq.ai/v2/api/bc-migration/migrations/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://app.vortexiq.ai/v2/api/bc-migration/migrations/{id}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.vortexiq.ai/v2/api/bc-migration/migrations/{id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

200

{
  "requestId": "<string>",
  "platform": "BC",
  "source": {
    "hash": "<string>",
    "label": "<string>"
  },
  "destination": {
    "hash": "<string>",
    "label": "<string>"
  },
  "autoHeal": true,
  "timestamps": {
    "created": "2023-11-07T05:31:56Z",
    "started": "2023-11-07T05:31:56Z",
    "updated": "2023-11-07T05:31:56Z"
  },
  "progress": {
    "phase": "<string>",
    "done": 123,
    "discovered": 123,
    "percent": 123,
    "ratePerSec": 123,
    "etaSeconds": 123,
    "overallEtaSeconds": 123,
    "lastProgressAt": "2023-11-07T05:31:56Z"
  },
  "counters": {
    "done": 123,
    "inProgress": 123,
    "failed": 123,
    "skipped": 123,
    "cancelled": 123,
    "exceptions": 123,
    "warnings": 123
  },
  "phases": [
    {
      "key": "<string>",
      "label": "<string>",
      "created": 123,
      "updated": 123,
      "skipped": 123,
      "matched": 123,
      "failed": 123,
      "pruned": 123,
      "total": 123,
      "components": [
        {
          "key": "<string>",
          "label": "<string>",
          "discovered": 123,
          "success": 123,
          "matched": 123,
          "failed": 123,
          "skipped": 123,
          "pruned": 123,
          "errors": 123,
          "total": 123,
          "widgets": 123
        }
      ]
    }
  ],
  "summaryLine": "<string>",
  "failuresOpen": 123,
  "pageTemplates": {
    "picked": [
      "<string>"
    ],
    "globalsRequested": true,
    "globalContextsPublished": 123
  },
  "forecast": {
    "products": 123,
    "variants": 123,
    "brands": 123,
    "categories": 123,
    "counts": {},
    "estimated": [
      "<string>"
    ],
    "memMB": 123,
    "cpus": 123,
    "etaSeconds": 123,
    "etaBreakdown": {},
    "etaAssumedRttMs": 123,
    "etaAssumedMs": {
      "read": 123,
      "write": 123,
      "heavy": 123
    },
    "destProducts": 123,
    "at": "2023-11-07T05:31:56Z"
  },
  "selective": true,
  "sourceStorefront": "<string>",
  "destStorefront": "<string>"
}

{
  "message": "Store Migration is not enabled 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.

Path Parameters

id · string · required

The migration request id returned by Create migration.

Response

200

application/json

Run detail.

requestId · string

platform · enum<string>

Available options: BC

source · object

Show child attributes

destination · object

Show child attributes

status · enum<string>

completed, failed, and cancelled are terminal.

Available options: queued, in_progress, paused, completed, failed, cancelled, partial_completed

autoHeal · boolean

mode · enum<string>

Available options: full, dry-run, verify, counts

conflictStrategy · enum<string>

Available options: skip, update, replace

timestamps · object

Show child attributes

progress · object

Show child attributes

counters · object

Show child attributes

phases · object[]

Show child attributes

summaryLine · string

failuresOpen · integer

Items still needing review.

pageTemplates · object

Present on selective page-template runs only: what was picked and how the channel-wide global content fared.

Show child attributes

forecast · object | null

Sizing and ETA estimate.

Sizing and ETA are priced from different bases deliberately: the ETA follows the run's real scope (picks, strategy, order statuses), while memory is pinned to store scale — the engine's working set does not shrink with a small pick, so sizing on picked counts alone would under-provision the run.

Show child attributes

selective · boolean

sourceStorefront · string | null

destStorefront · string | null