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());

GET /migrations/{id}/stream

Stream migration progress (SSE)

cURL

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

import requests

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

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}/stream', 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}/stream",
  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}/stream"

	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}/stream")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

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

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

"event: state\ndata: {\"requestId\":\"5A3C…\",\"status\":\"in_progress\",\"progress\":{\"phase\":\"products\",\"percent\":42}}\n\nevent: end\ndata: {}\n\n"

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

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

text/event-stream

SSE stream (text/event-stream). Each state event carries a run-detail JSON payload.

The response is of type string.