Stream migration progress
Server-Sent Events stream of live run state — the same feed the StagingPro UI uses for its progress bar.
The stream emits a state event immediately, another on every engine update, and a single end event when the run reaches a terminal status. A run that has already finished receives end straight away, so the stream always closes cleanly. Comment pings keep the connection alive.
const es = new EventSource('/v2/api/bc-migration/migrations/' + id + '/stream');
es.addEventListener('state', (e) => render(JSON.parse(e.data)));
es.addEventListener('end', () => es.close());
Authorizations
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.
Path Parameters
The migration request id returned by Create migration.
Response
SSE stream (text/event-stream). Each state event carries a run-detail JSON payload.
The response is of type string.