> ## Documentation Index > Fetch the complete documentation index at: https://docs.vortexiq.ai/llms.txt > Use this file to discover all available pages before exploring further. # 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. ## OpenAPI ````yaml vortex-apps/staging-pro/api/openapi.json GET /migrations/{id} openapi: 3.1.0 info: title: StagingPro V2 Migration API (BigCommerce) version: 2.0.0 description: >- REST API for the StagingPro V2 BC Migration app. Browse a connected store's catalogue, size a migration before you run it, launch bulk or selective store-to-store migrations, control runs, and follow live progress. All endpoints are served from `https://app.vortexiq.ai/v2/api/bc-migration` and are scoped to your organisation. Authenticate with a bearer token from the Login endpoint (scripts and services) or your signed-in session (browser). See [Authentication](/vortex-apps/staging-pro/api/authentication). contact: name: Vortex IQ Support url: https://www.vortexiq.ai/contact-us servers: - url: https://app.vortexiq.ai/v2/api/bc-migration description: Vortex IQ platform (production) security: - sessionAuth: [] - bearerAuth: [] tags: - name: Authentication description: >- Exchange your identity and your organisation's API credential for a bearer token. - name: Migrations description: >- Create migrations, list history, read run detail and per-item issues, and follow live progress. - name: Migration Controls description: Pause, resume, cancel, and verify-only re-runs. - name: Counts & Forecast description: Size a migration before launching it. Neither endpoint creates a run. paths: /migrations/{id}: get: tags: - Migrations summary: Get migration description: >- 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. operationId: getMigration parameters: - $ref: '#/components/parameters/MigrationId' responses: '200': description: Run detail. headers: X-Read-Source: description: >- Which store served this read: `opensearch`, `mysql`, or `engine`. Observability only. schema: type: string enum: - opensearch - mysql - engine content: application/json: schema: $ref: '#/components/schemas/MigrationDetail' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' components: parameters: MigrationId: name: id in: path required: true schema: type: string description: The migration request id returned by Create migration. example: 5A3C1B2E-7F4D-4E6A-9B8C-0D1E2F3A4B5C schemas: MigrationDetail: type: object properties: requestId: type: string platform: type: string enum: - BC source: $ref: '#/components/schemas/StoreRef' destination: $ref: '#/components/schemas/StoreRef' status: $ref: '#/components/schemas/MigrationStatus' autoHeal: type: boolean mode: type: string enum: - full - dry-run - verify - counts conflictStrategy: type: string enum: - skip - update - replace timestamps: type: object properties: created: type: string format: date-time started: type: string format: date-time updated: type: string format: date-time progress: type: object properties: phase: type: string description: The entity phase currently running. done: type: integer discovered: type: integer percent: type: number ratePerSec: type: number etaSeconds: type: integer description: Remaining seconds for the current phase. overallEtaSeconds: type: integer description: >- Remaining seconds for the whole run, calibrated against observed latency as the run proceeds. lastProgressAt: type: string format: date-time counters: type: object properties: done: type: integer inProgress: type: integer failed: type: integer skipped: type: integer cancelled: type: integer exceptions: type: integer warnings: type: integer description: Non-blocking issues; they do not fail the run. phases: type: array items: $ref: '#/components/schemas/PhaseResult' summaryLine: type: string failuresOpen: type: integer description: Items still needing review. forecast: oneOf: - $ref: '#/components/schemas/Forecast' - type: 'null' selective: type: boolean sourceStorefront: type: - string - 'null' destStorefront: type: - string - 'null' StoreRef: type: object properties: hash: type: string label: type: string MigrationStatus: type: string enum: - queued - in_progress - paused - completed - failed - cancelled - partial_completed description: '`completed`, `failed`, and `cancelled` are terminal.' PhaseResult: type: object description: Outcome for one entity phase (products, categories, and so on). properties: key: type: string label: type: string created: type: integer updated: type: integer skipped: type: integer matched: type: integer failed: type: integer pruned: type: integer total: type: integer components: type: array items: $ref: '#/components/schemas/ComponentResult' Forecast: type: object description: >- 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. properties: products: type: integer variants: type: integer brands: type: integer categories: type: integer counts: type: object additionalProperties: type: integer description: >- Per-entity counts the estimate was priced from, scoped by `selection` when supplied. estimated: type: array items: type: string description: Count keys that are sampled estimates rather than exact totals. memMB: type: integer description: >- Memory the run will be given (MiB). Pinned to store scale, not to the picked subset. cpus: type: number description: CPUs the run will be given. etaSeconds: type: integer description: Estimated total wall-clock for the run. etaBreakdown: type: object additionalProperties: type: number description: Per-phase seconds. etaAssumedRttMs: type: number description: The blended latency the estimate assumed. etaAssumedMs: type: object description: >- Per-operation-class latencies the estimate assumed, so heavy writes are not judged against a blended baseline. properties: read: type: number write: type: number heavy: type: number strategy: type: string enum: - skip - update - replace description: >- The conflict strategy the ETA was priced with. Absent means create-only. destProducts: type: integer description: >- Destination catalogue size at kickoff. Absent or `0` when the destination wasn't known. tier: type: string enum: - small - medium - large - xlarge - xxlarge - xxxlarge description: Capacity band the run was placed in. basis: type: string enum: - forecast - fallback - fix description: '`fallback` means counts were unavailable and defaults were used.' at: type: string format: date-time Error: type: object properties: error: type: string description: Machine-readable error code. message: type: string description: Human-readable explanation. status: type: integer description: 'Present on `bc_error`: the status BigCommerce returned.' errors: type: object additionalProperties: true description: 'Present on validation failures: field-level messages.' ComponentResult: type: object properties: key: type: string label: type: string discovered: type: integer success: type: integer matched: type: integer description: Already in sync with the source — examined, no write needed. failed: type: integer skipped: type: integer pruned: type: integer description: Destination-only items deleted under `replace`. errors: type: - integer - 'null' total: type: integer widgets: type: integer description: 'Page widgets only: widget nodes landed on the destination.' responses: Forbidden: description: >- Store Migration is not enabled for your organisation. Requests with no valid bearer token or session return `401` instead. content: application/json: schema: $ref: '#/components/schemas/Error' example: message: Store Migration is not enabled for this organization. NotFound: description: No such migration in your organisation. content: application/json: schema: $ref: '#/components/schemas/Error' securitySchemes: sessionAuth: type: apiKey in: cookie name: vortexiq_session description: >- 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](/vortex-apps/staging-pro/api/authentication). bearerAuth: type: http scheme: bearer bearerFormat: JWT description: >- A bearer token from [Login](/vortex-apps/staging-pro/api/login). 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. ````