Skip to main content
GET
Get migration

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.

Path Parameters

id
string
required

The migration request id returned by Create migration.

Response

Run detail.

requestId
string
platform
enum<string>
Available options:
BC
source
object
destination
object
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>

The engine's run mode. A True Replica run reports full here — its true-replica marker lives on the History row's mode, and its pipeline state in the replica block below.

Available options:
full,
dry-run,
verify,
counts
conflictStrategy
enum<string>

The run's data-treatment strategy (skip = Add New Only, update = Update Existing, replace = Make Exact Copy) — this is the authoritative field for how existing destination data was handled.

Available options:
skip,
update,
replace
timestamps
object
progress
object
counters
object
phases
object[]
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.

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.

selective
boolean
selectedEntities
string[]

The entity keys the run was created with.

sourceStorefront
string | null
destStorefront
string | null
replica
object | null

True Replica runs only: the verification pipeline's step tracker. null or absent on other runs.

reportAvailable
boolean

True Replica runs only: true once the store-owner report is durably stored. The report itself is viewed from the StagingPro UI's run detail page.