Skip to main content
GET
/
v1
/
namespaces
/
migrations
/
{migration_id}
Get Migration
curl --request GET \
  --url https://api.mixpeek.com/v1/namespaces/migrations/{migration_id} \
  --header 'Authorization: <authorization>'
{
  "migration_id": "<string>",
  "internal_id": "<string>",
  "namespace_id": "<string>",
  "config": {
    "migration_type": "re_extract",
    "source_namespace_id": "<string>",
    "target_namespace_id": "<string>",
    "target_namespace_name": "<string>",
    "feature_extractors": [
      {
        "feature_extractor_name": "<string>",
        "version": "<string>",
        "parameters": {}
      }
    ],
    "filters": {
      "collection_ids": [
        "<string>"
      ],
      "taxonomy_ids": [
        "<string>"
      ],
      "cluster_ids": [
        "<string>"
      ],
      "retriever_ids": [
        "<string>"
      ],
      "date_range": {},
      "auto_include_dependencies": true
    },
    "batch_options": {
      "batch_size": 100,
      "max_workers": 10,
      "retry_failed": true
    },
    "taxonomy_options": {
      "preserve_taxonomy_ids": true,
      "preserve_enrichment_fields": true,
      "re_run_enrichment": false,
      "migrate_reference_collections": true
    },
    "cluster_options": {
      "preserve_cluster_ids": true,
      "preserve_assignments": true,
      "migrate_artifacts": true,
      "preserve_centroids": true,
      "recompute_clusters": false
    },
    "retriever_options": {
      "preserve_retriever_ids": false,
      "migrate_interactions": false,
      "migrate_execution_history": false,
      "validate_references": true
    },
    "preserve_resource_ids": false,
    "dry_run": false,
    "webhook_url": "<string>"
  },
  "status": "draft",
  "progress": {
    "overall_status": "draft",
    "overall_progress_percent": 0,
    "current_stage": "namespace_setup",
    "stages": [
      {
        "stage": "namespace_setup",
        "status": "draft",
        "started_at": "2023-11-07T05:31:56Z",
        "completed_at": "2023-11-07T05:31:56Z",
        "progress_percent": 0,
        "items_total": 0,
        "items_completed": 0,
        "items_failed": 0,
        "error_message": "<string>"
      }
    ],
    "resources": [
      {
        "resource_id": "<string>",
        "resource_type": "bucket",
        "status": "draft",
        "progress_percent": 0,
        "error_message": "<string>"
      }
    ],
    "started_at": "2023-11-07T05:31:56Z",
    "estimated_completion": "2023-11-07T05:31:56Z"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "validation_result": {
    "valid": true,
    "errors": [
      {
        "loc": [
          "<string>"
        ],
        "msg": "<string>",
        "type": "<string>"
      }
    ],
    "warnings": [
      {
        "loc": [
          "<string>"
        ],
        "msg": "<string>",
        "type": "<string>"
      }
    ],
    "estimated_resources": {},
    "estimated_duration_seconds": 123
  },
  "dependency_graph": {
    "nodes": [
      {
        "resource_id": "<string>",
        "resource_type": "bucket",
        "dependencies": [
          "<string>"
        ],
        "tier": 0
      }
    ],
    "execution_order": [
      "<string>"
    ]
  },
  "task_id": "<string>",
  "started_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "error_message": "<string>",
  "additional_data": {}
}

Headers

Authorization
string
required

REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings.

Path Parameters

migration_id
string
required

Response

Successful Response

Response for getting migration details.

migration_id
string
required

Migration ID

internal_id
string
required

Organization internal ID

namespace_id
string
required

Source namespace ID

config
MigrationConfig · object
required

Migration configuration

status
enum<string>
required

Current status

Available options:
draft,
validating,
pending,
in_progress,
completed,
failed,
cancelled
progress
MigrationProgress · object
required

Progress tracking

created_at
string<date-time>
required

Creation timestamp

validation_result
ValidationResult · object

Validation result

dependency_graph
DependencyGraph · object

Dependency graph

task_id
string | null

Celery task ID

started_at
string<date-time> | null

Start timestamp

completed_at
string<date-time> | null

Completion timestamp

error_message
string | null

Error if failed

additional_data
Additional Data · object

Additional metadata